Skip to main content
Endpoint · POST /conversation/actions
Moves the conversation to a mailbox or a category. Exactly one of mailbox | category, never both. Fields
  • mailbox — { name } of the mailbox. Provide this or category, never both.
  • category — { name } of the category. Provide this or mailbox, never both.
In a list, this object goes in the actions array of a POST /conversation/actions — see Assembling an action list.

Executable example

An assign_mailbox on a conversation identified by phone and channel. Exactly one of mailbox or category, never both — and each mode behaves differently:
  • mailbox — assigns the conversation to the exact mailbox you name.
  • category — you don’t pick a mailbox: the system balances the load and assigns the conversation to the mailbox with the fewest pending chats within that category (handy for auto-distributing across a team). The category must have at least one mailbox configured.
Each channel has its own Predeterminada category, with the channel’s default mailbox inside. With several channels, category: { name: "Predeterminada" } matches several categories and returns 409 AMBIGUOUS_CATEGORY. To move the conversation to the default mailbox, pass it as mailbox with the name returned by the Mailboxes query: it is unique within the business.

Request

Response

202 Accepted — the group was accepted and runs in the background. The per-action result does not travel in the response (query it later — see How it runs).
string
Always processing: confirms the group was accepted and is running.
integer
How many actions in the array were admitted for execution — not how many succeeded.