Adding a tag to a request
| Method | set.tag_communications |
|---|---|
| Description | Adding a tag to a request |
| Available to | Partner, Client |
Request parameters
| Title | Type | Required | Valid values | Description |
|---|---|---|---|---|
access_token |
string | yes | Authentication session key | |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
|
communication_id |
number | no | Unique identifier of the case. For this identifier, you can obtain detailed information using the following methods "get.communications_report", "get.chats_report ", "get.goals_report", "get.offline_messages_report ", "get.calls_report". Required if not specified communication_ext_id |
|
communication_ext_id |
string | no | Unique identifier of the case. For this identifier, you can obtain detailed information using the following methods "get.chats_report ", "get.offline_messages_report ", "get.calls_report". Required if communication_id is not specified. Ignored if communication_id | is filled
|
communication_type |
enum | yes | chat, call, goal, offline_message |
Type of appeal. |
tag_id |
number | yes | Unique tag identifier, see "get.tags" method |
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"set.tag_communications", "params":{ "access_token":"string", "user_id":"number", "communication_id":"number", "communication_ext_id":"string", "communication_type":"enum", "tag_id":"number" } }
### JSON response structure```json
{
"jsonrpc":"2.0",
"id":"number",
"result":{
}
}
List of returned errors
See the section "List of errors for methods with the verb set"