Removes a tag from a communication. This method can also be used to remove a sales tag.
Removes a tag from a communication. This method can also be used to remove a sales tag
| Method | unset.tag_communications |
|---|---|
| Description | Removes a tag from a communication. This method can also be used to remove a sales tag. |
| Who has access | Agents and clients |
Request parameters
| Name | Type | Required | Valid values | Description |
|---|---|---|---|---|
access_token |
string | yes | Session key used to authenticate the request | |
user_id |
number | no | Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users". | |
communication_id |
number | no | Unique communication ID. Use this ID to retrieve detailed information with "get.communications_report", "get.chats_report", "get.goals_report", "get.offline_messages_report", or "get.calls_report". Required when communication_ext_id is omitted. | |
communication_ext_id |
string | no | External communication ID. Use this ID to retrieve detailed information with "get.chats_report", "get.offline_messages_report", or "get.calls_report". Required when communication_id is omitted. Ignored when communication_id is provided. | |
communication_type |
enum | yes | chat call goal offline_message |
Communication type |
tag_id |
number | yes | Unique tag ID. Retrieve available tags with "get.tags". |
Example request
{
"jsonrpc":"2.0",
"id":"number",
"method":"unset.tag_communications",
"params":{
"access_token":"string",
"user_id":"number",
"communication_id":"number",
"communication_type":"enum",
"tag_id":"number"
}
}
Example response
{
"jsonrpc":"2.0",
"id":"number",
"result":{
}
}
List of returned errors
See the "List of errors for unset methods" section.