Skip to main content
Route Agent

Body

application/json
source
string

System or integration that initiated the routing request. E.g: "chat", "inbound_phone", or "email".

source_id
string

Source-system identifier for the entity being routed. Typically the "Dialogue" integer ID.

reason
string

Human-readable reason or context for routing.

routing_policy
string

The strategy to do routing with.

routable_entities
object[]

A list of all routable entities.

metadata
object

Additional routing context for provider-specific decisions.

Response

OK

routed_agents
object[]

Agents that were routed, if any. Teams are converted to agents. These agents must represent Atonom agent/user IDs.

status
string

The status of the route. Can be useful for communicating queued, etc statuses.