Skip to main content

Conversation Assignment

Assign inbound conversations to team members and manage the assignee.

📄️List users assignable to conversations

Returns the list of team members of your company that can be assigned to a conversation. Use this to populate an assignee picker in your application before calling the assign endpoint. Each entry includes the user ID required as input by POST /conversations/{chatId}/assignee, the display name, and an optional avatar URL. Returns 401 if the API key is missing or invalid. Returns 502 if the upstream user-profile service is temporarily unavailable; this is a transient condition and the request can be safely retried after a short delay.

📄️Remove the assignee from a conversation

Clears the current assignee of the conversation, leaving it unassigned. The conversation itself remains active and continues to appear in the inbox; only the ownership link to a specific team member is removed. This operation is idempotent: calling it on a conversation that has no assignee succeeds and still returns 204. Returns 404 if the conversation does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.

📄️Assign a conversation to a team member

Assigns the specified conversation to a user of your company. The assignee becomes the primary owner of the conversation and will receive notifications for new inbound messages on it. A conversation can have at most one assignee — calling this endpoint replaces any existing assignment. To remove the assignee without replacing it, use DELETE on the same resource. The user being assigned must belong to your company; cross-company assignment is not supported and results in a 404. Returns 400 if the request body is missing or `userId` is null. Returns 404 if the conversation or the target user does not exist or does not belong to your account. Returns 401 if the API key is missing or invalid.

Last updated on