Assign conversation

This method assigns a specific conversation to a specific administrator (or removes an assignment).

URL

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

The ID of the conversation should be used as {id}.

Parameters

Authentification parameters. id_as_string parameter.

Parameter Type Description
admin Optional[ID] ID of admin being assigned to the dialog. Dialog is unassigned from current admin if this parameter is empty.
from_admin ID/default_admin ID of admin who assigns another admin to the dialog or default_admin to assign as default admin.
random_id Optional[integer] random integer to validate created message with RTS message. Default: 0

Note

If the conversation is already assigned to this admin, the answer with 200 status will be returned.

Use from_admin to control the admin who assigns conversation (not being assigned).

random_id is used to validate created message with Realtime services. You can use 32-bit integer, which will be returned as one of ConversationPart fields, created by tour request. You can't use conversation part ID because Realtime services is asynchronous and may receive the new message before(or after. It happens randomly as order is not set) you get response to message part creation.

Response

In case you're getting empty data field in response, assigned admin was not changed.

In case new message was created, data field will contain the wollowing:

  • id: ID - created assignment message identificator
  • part_group: ID - identificator of conversation part, owning created message

Example:

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

Examples

Assign dialog with ID=716 to admin with ID=819 as admin with ID=912:

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