Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Jobs

Create a job

Create a new job. A job can be added to any job group, except a job group marked Financially Complete (required scope jobs:write)

post/v1/jobs

Headers

Customer-Idinteger required

The customer identifier

Request body

typeIdinteger required

The unique identifier of the type assigned to this job

contactIdinteger required

The unique identifier of the contact (customer) for who this job is to be performed

plannedDurationinteger nullable

The planned duration for the job, indicated in minutes. If not provided, the default duration for the job type will be used

referencestring nullable

The internal reference of the job - should usually be unique. If not provided and job type auto-reference set, auto-referenced value will be used

descriptionstring nullable

The textual details about the job

personIdstring uuid nullable

The unique uuid identifier of the person who will serve as primary point of contact for the job

orderNumberstring nullable

The order number associated to the job. May be required, dependent upon job type

jobGroupIdinteger nullable

The unique identifier of the job group to which this job belongs

categoryIdinteger nullable

The unique identifier of the category that the job is assigned to

siteContactIdinteger nullable

The unique identifier of the site contact for this job<br/>If provided, the contact must exist within the customer's account

Example request

{
  "typeId": 5514123,
  "contactId": 5514123,
  "plannedDuration": 90,
  "reference": "ABC/5514123",
  "description": "New boiler install - please remove and retain the old boiler",
  "personId": "3729c414-ed21-4849-816f-25d332265dc8",
  "orderNumber": "PAO/1312KU",
  "jobGroupId": 42,
  "categoryId": 5514123,
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ],
  "siteContactId": 15548440
}

Response

Created

idinteger

Identifier of the newly created record