| Parameter name | Value | Description | Notes |
|---|---|---|---|
id |
string |
Identifier of the status. | read-only |
name |
string |
Name of the status. | writable. Max length 127. |
description |
string |
Description of the status. | writable. Max length 65536. |
color |
string |
Color of the status. HTML Color format: #xxxxxx | writable |
native |
string |
If is a platform predefined status. Read-only. | read-only |
Deletes an entry on the status list. Only no native status can be deleted.
Authentication is required to execute this request. Please refer to Authentication for more.
{statusId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
statusId |
string |
Status identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the status list. Only with no native statuses
Authentication is required to execute this request. Please refer to Authentication for more.
{statusId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
statusId |
string |
Status identifier. |
Do not supply a request body with this method.
If successful, this method returns a Status resource in the response body.
Returns entries on the status list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Optional query parameters | ||
appointmentId |
datetime |
Gets available change statuses for an appointment. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the status list.
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Status resource with the following properties:
| Parameter name | Value | Description | |
|---|---|---|---|
| Required Property | |||
name |
string |
Name of the status. | writable. Max length 127. |
| Optional Properties | |||
description |
string |
Description of the status. | writable. Max length 65536. |
color |
string |
Color of the status. HTML Color format: #xxxxxx | writable |
If successful, this method returns a Status resource in the response body.
Updates an entry on the status list.
Authentication is required to execute this request. Please refer to Authentication for more.
{statusId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
statusId |
string |
Status identifier. |
In the request body, supply a Status resource with the following properties:
| Parameter name | Value | Description | |
|---|---|---|---|
| Optional Properties | |||
name |
string |
Name of the status. | writable. Max length 127. |
description |
string |
Description of the status. | writable. Max length 65536. |
color |
string |
Color of the status. HTML Color format: #xxxxxx | writable |
native |
string |
If is a platform predefined status. Read-only. | read-only |
If successful, this method returns a Status resource in the response body.