Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this status, as the conversations store it |
The unique code for this status, as the conversations store it | ||
| name | string | The display name, e.g. "Waiting on client" |
The display name, e.g. "Waiting on client" | ||
| sortOrder | integer | Position in the status picker |
Position in the status picker | ||
| isActive | boolean | Whether the status is offered when setting a conversation's status |
Whether the status is offered when setting a conversation's status | ||
| color | string | Display colour, e.g. "#3B82F6" |
Display colour, e.g. "#3B82F6" | ||
| isDone | boolean | Whether the status closes a conversation |
Whether the status closes a conversation | ||
| archiveOnDone | boolean | Whether setting this status also archives the conversation in Outlook or Gmail (Done statuses only) |
Whether setting this status also archives the conversation in Outlook or Gmail (Done statuses only) | ||
| offerOnSend | boolean | Whether the reply Send button offers this status ("Send & Done"). Any status may be offered. |
Whether the reply Send button offers this status ("Send & Done"). Any status may be offered. | ||
JSON Example
{
"code": "string",
"name": "string",
"sortOrder": 0,
"isActive": false,
"color": "string"
}