Assign Conversation Request

Home/

REST API Reference

Payload of the request to assign a conversation

message_typestringrequired

Value:"assignment"

Example:"assignment"

typestringrequired

Enum:"admin""team"

Example:"admin"

admin_idstringrequired

The id of the admin who is performing the action.

Example:"12345"

assignee_idstringrequired

The id of the admin or team which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet 0 if you want this assign to no admin or team (ie. Unassigned).

Example:"4324241"

bodystring

Optionally you can send a response in the conversation when it is assigned.

Example:"Let me pass you over to one of my colleagues."

{
  "message_type": "assignment",
  "type": "admin",
  "admin_id": "12345",
  "assignee_id": "4324241",
  "body": "Let me pass you over to one of my colleagues."
}