Add a conversation tag

Adds a tag to conversation.

URL

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

For {id} you should use conversation id.

Parameters

Auth parameters.
id_as_string parameter.

Parameter	Type	Description
tag	string[1;255]	A tag name. String from 1 to 255 characters
from_admin	Optional[ID/default_admin]	Set operator ID who operates tag or default_admin to act as default admin
random_id	Optional[integer]	A random number used to match reply created with one sent via RTS. Defaults to 0
action	Deprecated. Optional[add/delete]	Deprecated. Defaults to add. Use DELETE method instead of delete value .

Notes

Use from_admin parameter in order to set operator who adds a tag.

random_id is used for matching a created reply with one sent via Realtime services. You can set a random 32-bit number here. The same number will be returned in random_id field of ConversationPart object in RTS message. Note, that you can not use object's ID here as Realtime services works asynchronously and can get reply earlier than reply creation request responds.

Response

data field will contain an object with fields:

• id: ID - created reply identifier
• part_group: ID - question identifier a created reply is connected to

Example:

{
  "data": {
    "id": 123,
    "part_group": 345
  },
  "meta": {
    "status": 200
  }
}

Exceptions

Standard Web API exceptions.

This method errors

Error	Code	Description
ConversationTagAlreadyAssigned	400	If tag already exists during tag creation

Examples

Adding tag mytag to conversation with ID=716 from admin with ID=912:

curl -X POST \
  -H "Authorization: Token XXX" \
  --data-urlencode 'tag=mytag' \
  --data-urlencode 'from_admin=912' \
  'https://api.dashly.app/conversations/716/tag'