These are the endpoints that are available under the /status path, which lists all the different status objects that are available on your business account.
Endpoint | Description |
|---|---|
GET /status | Returns all status objects on your business' account in array format. |
| POST /status | Creates a new status substatus object on an account. Request body/payload: Must pass a status object in the request body/payload. For these calls, you need to pass a status object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a status object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| PUT /status | Updates the specified status substatus object. Request body/payload: Must pass a status object in the request body/payload. For these calls, you need to pass a status object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a status object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
There are no parameters included with status calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a status object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"active": true,
"businessId": 43111,
"dependsOn": null,
"sortOrder": 7,
"status": "OPEN",
"statusId": null,
"statusType": "APPOINTMENT",
"subStatus": "DOZING",
"userSelectable": true
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"active": true,
"businessId": 43111,
"createdDate": 1541102830739,
"createdUser": "JoeSchmo",
"dependsOn": null,
"modifiedDate": 1541779932507,
"modifiedUser": "JoeSchmo",
"sortOrder": 5,
"status": "OPEN",
"statusId": 1948,
"statusType": "APPOINTMENT",
"subStatus": "RUNNING_LATE",
"userSelectable": true
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[{
"active": true,
"businessId": 43111,
"createdDate": 1541101742804,
"createdUser": "JoeSchmo",
"dependsOn": null,
"modifiedDate": 1541102830700,
"modifiedUser": "JoeSchmo",
"sortOrder": 1,
"status": "OPEN",
"statusId": 1915,
"statusType": "APPOINTMENT",
"subStatus": "OPEN",
"userSelectable": true
}] |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"active": true,
"businessId": 43111,
"createdDate": 1541779932457,
"createdUser": "JoeSchmo",
"dependsOn": null,
"modifiedDate": null,
"modifiedUser": null,
"sortOrder": 6,
"status": "OPEN",
"statusId": 2146,
"statusType": "APPOINTMENT",
"subStatus": "Ready for clients",
"userSelectable": true
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"active": true,
"businessId": 43111,
"createdDate": 1541101742804,
"createdUser": "JoeSchmo",
"dependsOn": null,
"modifiedDate": 1541779932507,
"modifiedUser": "JoeSchmo",
"sortOrder": 1,
"status": "OPEN",
"statusId": 1915,
"statusType": "APPOINTMENT",
"subStatus": "OPEN",
"userSelectable": true
} |
Property name | Type | Required | Writable | Description |
|---|---|---|---|---|
active | boolean | Yes | Indicates whether or not the specified status should return in any GET calls. | |
businessId | integer | Yes | Provides unique numeric ID of the business the specified status belongs to. | |
createdDate | integer | Displays as the date the specified status was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
createdUser | string | Displays the username of the user who created specified status. | ||
dependsOn | array | Displays as an array of properties that the specified status depends on. | ||
| modifiedDate | integer | Displays as the date the specified status was last updated in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| modifiedUser | string | Displays the username of user who last modified specified status. | ||
| sortOrder | integer | Yes | Displays the order in which the specified status appears in the list of statuses. | |
| status | string | Yes | Yes | Displays as specified status in string form. Has acceptable values PENDING, PENDING_CONFIRMATION, PENDING_WAITLIST, OPEN, READ_ONLY, READ_ONLY_FREE, NO_SHOW, COMPLETED, CANCELLED, and DELETED. |
| statusId | integer | Yes, on PUT calls | Provides unique numeric ID for the specified status. | |
| statusType | string | Should be set to "APPOINTMENT". | ||
| subStatus | string | Yes | Yes | Displays as the substatus of the specified status. PENDING, PENDING_CONFIRMATION, PENDING_WAITLIST, OPEN, READ_ONLY, READ_ONLY_FREE, NO_SHOW, RUNNING_LATE, INPROGRESS, CHECKEDIN, COMPLETED, CONFIRMED, CANCELLED, and DELETED. |
| userSelectable | boolean | Yes | Indicates whether or not the specified status can be selected by the user. |