Skip to main content
Puts a live agent on a contact, as assigning one on the panel does. The agent starts at once: its workflow’s Assigned to the agent start, or a first plan. A contact has at most one agent in each role; putting the same agent on again changes only the deal it works.
Needs the agents.contacts:write scope.

Path parameters

Body

Request

Response

200 OK — the agents now working the contact. contact is the contact, and data the agents working them that haven’t been released. For each: the agent; status — active (working) or paused; since when; the deal it works (its title and deal_id), if any; paused_reason and resume_at while paused; needs_attention when it handed over to the team; the channels it can answer on; and workflow — where the conversation is in its workflow (the version, the block, and what it is waiting for), or null.

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault. Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.