Toggle Conversation Status
This endpoint allows you to Toggle the status of the conversation between open and resolved.
Settings:
|
URL |
https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status |
|
Method |
JSON via POST |
Authorization:
|
Header Parameter |
Description |
|
api_access_token |
user API key |
The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.
Path Parameters:
|
Parameter |
Description |
Required |
|
account_id |
The numeric id of the account |
yes |
|
conversation_id |
The numeric id of the conversation |
yes |
Request body Parameters:
|
Parameter |
type |
Description |
Required |
|
status |
string |
The status of the conversation
|
yes |
Request body example:
{
"status": "resolved"
}
Response:
{
"payload": {
"success": true,
"conversation_id": 0,
"current_status": "resolved",
"snoozed_until": 0
}
}
Response-Explain:
|
Parameter |
Description |
|
payload |
Object containing the response |
|
payload -> success |
Indicates whether the status of the conversation has changed |
|
payload -> conversation_id |
Numeric id of the conversation |
|
payload -> current_status |
The current status of the conversation
|
|
payload -> snoozed_until |
If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time. |
Created with the Personal Edition of HelpNDoc: Easy CHM and documentation editor