Skip to navigation
API ReferenceConversations

Assign a conversation

Assigns the conversation to an agent or to a team. When the request has assignee_id, the API ignores team_id. Send assignee_id: null to remove the agent. An assignee_id that is not an agent of the account also removes the agent. A team_id that is not a team of the account removes the team. Neither case returns an error.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

conversation_idintegerRequired

The conversation number in the dashboard URL (display_id). It is not the internal id of the conversation.

Request

This endpoint expects an object.
assignee_idinteger or nullOptional
The id of the agent.
assignee_typeenumOptional

Send AgentBot to assign an agent bot. The default is an agent.

Allowed values:
team_idinteger or nullOptional
The id of the team.

Response

The new agent, the new team, or null.

Errors

401
Unauthorized Error
404
Not Found Error