Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

JobTypes

Create a new Job Type

Creates a new Job Type and returns the created Job Type object.

post/v2/jobtypes

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

namestring required

The name of the job type.

avgDurationnumber

The average duration in minutes.

displayOrdernumber required

The position of the job type in the display list.

disabledboolean

Indicates whether the job type is disabled or not.

applyToSubAccountsboolean

When true, the job type is also created on all franchise sub-accounts.

Example request

{
  "name": "Some type",
  "avgDuration": 60,
  "displayOrder": 1,
  "applyToSubAccounts": true
}

Response

The created Job Type.

idstring

The ID of the job type (prefix JT-).

namestring

The name of the job type.

avgDurationnumber

The average duration of the job type in minutes.

displayOrdernumber

The display order of the job type.

disabledboolean

Indicates whether the job type is disabled or not.

Example response

{
  "id": "JT-8718036049ec4c4d",
  "name": "Cleaning",
  "avgDuration": 60,
  "displayOrder": 1
}