Add or remove a conversation tag

This method adds a conversation tag or removes it.

URL

POST https://api.dashly.app/v1/conversations/{id}/tag

For {id} you can use conversation id

Arguments

This method follows the general rules. Arguments are transmitted as GET or POST parameters.

Argument Description
auth_token Required. Authorization token (requires scope: conversations-write)
action Required. set add to add a tag and delete to remove.
tag Required. Name of the tag (should not contain ,)
from_admin Send admin ID<!-- in case admin (not a bot) adds a tag. You can use default_admin
bot_name Name of the bot which adds the tag. Default: Bot.-->
random_id Random ConversationPart ID for sending integrity control. default: 0

If such a tag already exists, or does not yet — status 200 will be returned.

Answer

{
  "data": {
  }
  "meta": {
    "status": 200
  }
}

Will be empty.

Example

<!-- Add tag mytag to conversation with ID=716 on behalf of bot:

curl -X POST \
  --data-urlencode 'auth_token=XXX' \
  --data-urlencode 'tag=mytag' \
  --data-urlencode 'action=add' \
  'https://api.dashly.app/v1/conversations/716/tag'

Remove tag mytag from conversation with ID=716 on behalf of bot:

curl -X POST \
  --data-urlencode 'auth_token=XXX' \
  --data-urlencode 'tag=mytag' \
  --data-urlencode 'action=delete' \
  'https://api.dashly.app/v1/conversations/716/tag'

--> Add tag mytag to conversation with ID=716 on behalf of admin with ID=912:

curl -X POST \
  --data-urlencode 'auth_token=XXX' \
  --data-urlencode 'tag=mytag' \
  --data-urlencode 'action=add' \
  --data-urlencode 'from_admin=912' \
  'https://api.dashly.app/v1/conversations/716/tag'