Jobs

Designing

POST

/properties/{propertyID}/jobs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Success

application/json

Headers

Bodyapplication/json

🟠400400 Bad request

🟠429429 Too many requests

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location '/properties/657/jobs' \
--header 'X-API-VERSION: 2.0' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "customerContactID": "55",
    "siteContactID": "78",
    "settingsJobDescriptionID": "1",
    "notes": "20May 15:277",
    "serviceReminderInstance1ID": 10,
    "serviceReminderInstance2ID": 86,
    "serviceReminderInstance3ID": 35,
    "skills": null,
    "customerReference": "nostrud",
    "quotedAmount": "4545",
    "priority": "Not_Important",
    "businessUnitID": 1,
    "userGroupID": 1
}'

Response Example

201 - Example 1

{
    "id": 0,
    "createdOnDateTime": "2019-08-24T14:15:22.123Z",
    "createdByType": "string",
    "createdByUserID": 0,
    "createdByUser": "string",
    "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
    "propertyID": 0,
    "customerContactID": "string",
    "customerContact": {
        "contactID": 0,
        "fullName": "string",
        "mobile": "string",
        "telephone": "string",
        "email": "string"
    },
    "siteContactID": "string",
    "siteContact": {
        "siteContactID": 0,
        "fullName": "string",
        "mobile": "string",
        "telephone": "string",
        "email": "string"
    },
    "description": "string",
    "settingsJobDescriptionID": "string",
    "notes": "string",
    "jobType": 0,
    "serviceReminderInstance1ID": 0,
    "serviceReminderInstance1Name": "string",
    "serviceReminderInstance2ID": 0,
    "serviceReminderInstance2Name": "string",
    "serviceReminderInstance3ID": 0,
    "serviceReminderInstance3Name": "string",
    "skills": [
        {
            "id": 0,
            "skill": "string"
        }
    ],
    "pipelineID": 0,
    "pipelineName": "string",
    "stageID": 0,
    "stageName": "string",
    "usersCurrentlyAssignedToJob": [
        {
            "id": 0,
            "fullName": "string"
        }
    ],
    "contractID": 0,
    "hasRelatedRecall": true,
    "recallOfParentJobID": 0,
    "blameUserID": 0,
    "blameUser": "string",
    "jobReportedDateTime": "2019-08-24T14:15:22.123Z",
    "expectedOnsiteDateTime": "2019-08-24T14:15:22.123Z",
    "expectedCompletionDateTime": "2019-08-24T14:15:22.123Z",
    "tags": [
        "string"
    ],
    "customerReference": "string",
    "quotedAmount": "string",
    "priority": "Important",
    "businessUnitID": 0,
    "businessUnit": "string",
    "userGroupID": 0,
    "userGroup": "string",
    "status": "Open",
    "completed": {
        "completedByID": 0,
        "completedByUser": "string",
        "completedByType": "string",
        "completedOnDateTime": "2019-08-24T14:15:22.123Z"
    },
    "closed": {
        "closedByID": 0,
        "closedByUser": "string",
        "closedByType": "string",
        "closedOnDateTime": "2019-08-24T14:15:22.123Z",
        "closedOutcome": "string",
        "focReason": "string",
        "focNote": "string",
        "abortReason": "string",
        "abortNote": "string"
    },
    "isJobOnHold": true,
    "onHoldReasonID": 0,
    "onHoldReasonDescription": "string",
    "afterSalesCareFeedback": "string",
    "afterSalesCareComments": "string",
    "hasSLA": true,
    "SLAType": "string",
    "SLAStatus": "string",
    "links": {
        "self": "string",
        "property": "string",
        "appointments": "string"
    }
}

Modified at 2026-07-15 16:52:38

Jobs