Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Job Sub Status

Create a new Job Sub Status

Creates a new Job Sub Status and returns the created Job Sub Status object.

post/v2/jobSubStatus

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

namestring required

The name of the job sub status.

parentName'In progress' | 'Canceled' | 'Pending' | 'done pending approval' required

The name of the parent job status.

color'silver' | 'blue' | 'green' | 'orange' | 'red' | 'anthracite' | 'grey' | 'azure' | 'denim' | 'royalBlue' | 'crimson' | 'cerise' | 'apricot' | 'cream' | 'bronze' | 'yellow' | 'emerald' | 'forest' | 'purple' | 'plum' | 'lavender' | 'violet' | 'slate' required

The color key for the job sub status. Available colors:<br>silver: #cccccc<br>blue: #004795<br>green: #6d960c<br>orange: #cc9707<br>red: #e35a36<br>anthracite: #282e36<br>grey: #666666<br>azure: #3589E9<br>denim: #24589B<br>royalBlue: #000ED2<br>crimson: #B91C1C<br>cerise: #E11D48<br>apricot: #FBAB33<br>cream: #E8CF63<br>bronze: #D58E41<br>yellow: #FFD400<br>emerald: #22C55E<br>forest: #3E802B<br>purple: #9747FF<br>plum: #B25494<br>lavender: #D574E4<br>violet: #391E86<br>slate: #3B4B52

Example request

{
  "name": "New",
  "parentName": "In progress",
  "color": "silver"
}

Response

The created Job Sub Status.

idstring

The ID of the job sub status (prefix JSS-).

namestring

The name of the job sub status.

parentNamestring

The name of the parent job status.

color'silver' | 'blue' | 'green' | 'orange' | 'red' | 'anthracite' | 'grey' | 'azure' | 'denim' | 'royalBlue' | 'crimson' | 'cerise' | 'apricot' | 'cream' | 'bronze' | 'yellow' | 'emerald' | 'forest' | 'purple' | 'plum' | 'lavender' | 'violet' | 'slate'

The color key of the job sub status.

Example response

{
  "id": "JSS-BA5r7o4bqzR9MONa",
  "name": "Follow Up",
  "parentName": "In progress",
  "color": "lavender"
}