ReferenceConversations
Conversations
Public inbox. Same visibility as the product for the user who minted the key.
List threads, read messages, reply with text, close, snooze, prioritize, note, tag and invite staff.
| HTTP | Path | Scope |
|---|---|---|
| GET | /api/v1/conversations | rest.conversations.read |
| GET | /api/v1/conversations/{id} | rest.conversations.read |
| PATCH | /api/v1/conversations/{id} | rest.conversations.write |
| GET | /api/v1/conversations/{id}/messages | rest.conversations.messages.read |
| POST | /api/v1/conversations/{id}/messages | rest.conversations.write |
| POST | /api/v1/conversations/{id}/media | rest.conversations.write |
| GET | /api/v1/conversations/{id}/notes | rest.conversations.read |
| POST | /api/v1/conversations/{id}/notes | rest.conversations.write |
| GET | /api/v1/conversation-tags | rest.conversations.read |
| POST | /api/v1/conversations/{id}/tags | rest.conversations.write |
| DELETE | /api/v1/conversations/{id}/tags/{tag_id} | rest.conversations.write |
| GET | /api/v1/conversations/{id}/participants | rest.conversations.read |
| POST | /api/v1/conversations/{id}/participants | rest.conversations.write |
| DELETE | /api/v1/conversations/{id}/participants/{participant_id} | rest.conversations.write |
Filter list with q, status (open / pending / closed / snoozed) and contact_id. PATCH status is open, closed or snoozed — pending stays a list filter. snoozed_until is required with status snoozed and must be future. Already-snoozed refuses a new snooze: open first. priority: low | normal | high | urgent. Reply is text; DNC, closed thread and inactive channel fail closed. Internal notes are staff-only, 1–5000 chars, distinct from /api/v1/notes. Inbox tags are a different catalog (GET /conversation-tags), max 10. Staff participants: observer | collaborator; collaborator on an exclusive channel is 403.
Query
| Parameter | Type | Notes |
|---|---|---|
| q | string | Search the thread. |
| status | open | pending | closed | snoozed | Filter. pending is not a PATCH. |
| contact_id | UUID | Threads for that contact. |
| limit / cursor | number / string | Cursor page. limit 1–100. |
Fields
| Field | Type | Notes |
|---|---|---|
| id / display_id | UUID / string | Public thread identity. |
| status | string | open, pending, closed, snoozed. |
| can_reply | boolean | WhatsApp false = 24h window closed. |
| owner_id | UUID | null | Member. Exclusive unassign fails closed. |
| priority | low | normal | high | urgent | PATCH. |
| content | string | Text reply. 201 { id, status: pending }. |