Skip to content

Set tag sales

Setting sales tags for communications

Method set.tag_sales
Description Setting sales tags for communications
Who has access Partner, Customer

You can access this method if your website has the active option "Account sales"

Parameters of a request

Title Type Required Valid values Description
access_token string yes Authentication session key
user_id number no Unique ID of an agent's customer user who makes request
Is required for agent
To access a list of customer users, use the method "get.customer_users"
communication_id number yes Communication unique ID. With this ID you can get detailed information using the following methods "get.communications_report", "get.chats_report ", "get.goals_report", "get.offline_messages_report ", "get.calls_report"
communication_type enum yes chat, call, goal, offline_message Communication type
date_time iso8601 yes YYYY-MM-DD hh:mm:ss Date and time of a transaction
Cannot be earlier than the communication date
transaction_value number yes Transaction value
comment string no Maximum length is 255 symbols Comment to a transaction

Parameters of a reply

Title Type Required Description
id number yes Sales unique ID

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"set.tag_sales",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "communication_id":"number",
    "communication_type":"enum",
    "date_time":"iso8601",
    "transaction_value":"number",
    "comment":"string"
  }
}

JSON reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "id":"number"
  }
}

List of returning errors

Refer to the section "List of errors for the methods with the verb set"