PUT /api/v2/custom_statuses/{custom_status_id}
Takes a custom_status object that specifies the properties to update.
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_status_id |
Integer | Yes |
The id of the custom status |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_status |
Object | No | |
custom_status.active |
Boolean | No |
True if the custom status is set as active; inactive if false |
custom_status.description |
String | No |
The dynamic content placeholder, if present, or the "description" value, if not. See Dynamic Content Items |
custom_status.end_user_description |
String | No |
The dynamic content placeholder, if present, or the "end_user_description" value, if not. See Dynamic Content Items |
custom_status.agent_label |
String | No |
The dynamic content placeholder, if present, or the "agent_label" value, if not. See Dynamic Content Items |
custom_status.end_user_label |
String | No |
The dynamic content placeholder, if present, or the "end_user_label" value, if not. See Dynamic Content Items |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.