Conversations
Threads in the shared inbox, assignment and AI handover.
The conversation object
As returned by GET /conversations, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
contact_idrequired | string (uuid) | UUID |
contactrequired | object | The person on the other side |
contact.idrequired | string (uuid) | UUID |
contact.namerequired | string | null | Display name |
contact.phonerequired | string | null | E.164 phone number, when the channel has one |
channelrequired | string (enum) | The channel the thread lives onwhatsappmessengerinstagramwebchatpersonal_whatsapp |
connection_idrequired | string (uuid) | null | For personal WhatsApp: the linked number this thread is on |
statusrequired | string (enum) | Where the thread sits in the inboxopenpendingclosed |
assigned_torequired | string (uuid) | null | Member user id, or null when unassigned |
ai_ownershiprequired | string (enum) | null | Who is answering: the assistant, a human, or null = inherit from the channel’s assistant bindingaihuman |
needs_attentionrequired | boolean | The assistant handed this thread to a human and nobody has picked it up |
handoff_reasonrequired | string | null | Why the thread was handed to a human, when it was |
last_message_textrequired | string | null | Preview of the most recent message |
last_message_atrequired | string (date-time) | null | |
unread_countrequired | integer | Inbound messages not yet marked read |
created_atrequired | string (date-time) | ISO 8601 timestamp |
updated_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
8 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.