Skip to the pageRivier/ Reference/ inbox
inbox157
- Desk agentsget/contact-centre/agents
- Add an agent to the desk (a person's seat or an AI agent)post/contact-centre/agents
- Change an agent's name, skills or limitput/contact-centre/agents/{id}
- Remove an agent with no open conversationsdelete/contact-centre/agents/{id}
- Set an agent online, away or offlinepost/contact-centre/agents/{id}/presence
- What one agent has doneget/contact-centre/agents/{id}/stats
- Inbox contact centre canned listget/contact-centre/canned
- Add a canned replypost/contact-centre/canned
- Change a canned replyput/contact-centre/canned/{id}
- Remove a canned replydelete/contact-centre/canned/{id}
- A canned reply filled in for one conversation and one agent, ready to sendpost/contact-centre/canned/{id}/render
- Conversations, newest first: filter by status, agent, queue or customerget/contact-centre/conversations
- Open a conversation for a customerpost/contact-centre/conversations
- Inbox contact centre conversation getget/contact-centre/conversations/{id}
- Give a conversation to an agentpost/contact-centre/conversations/{id}/assign
- Close a conversation, with how it was resolvedpost/contact-centre/conversations/{id}/close
- What a reply to this conversation needsget/contact-centre/conversations/{id}/composer
- Hand a conversation overpost/contact-centre/conversations/{id}/handoff
- A person approves or declines a hand-off to an AI agentpost/contact-centre/conversations/{id}/handoff/decision
- Add an internal note the customer never seespost/contact-centre/conversations/{id}/notes
- Put a conversation back in its queuepost/contact-centre/conversations/{id}/release
- Reply to the customer on the conversation's channel as the agent it is withpost/contact-centre/conversations/{id}/reply
- Set a conversation's tagsput/contact-centre/conversations/{id}/tags
- Everything with this customer in one listget/contact-centre/conversations/{id}/timeline
- Inbox contact centre history getget/contact-centre/customers/history
- How a text is counted by the carrierpost/contact-centre/measure
- The supervisor viewget/contact-centre/overview
- Inbox contact centre queue listget/contact-centre/queues
- Create a queuepost/contact-centre/queues
- Change a queueput/contact-centre/queues/{id}
- Remove a queue with no open conversationsdelete/contact-centre/queues/{id}
- The per-agent traceget/contact-centre/traces
- Everything said in a conversation across channelsget/conversations/{id}/timeline
- The message event stream from a cursorget/message-events
- A server-sent stream of message events; reconnect with Last-Event-ID to resumeget/message-events/stream
- Search the message log across email, SMS, WhatsApp and voiceget/messages
- Webhook deliveries about messages that ran out of attemptsget/messages/dead-letters
- The error catalogueget/messages/errors
- Inbox message error explainget/messages/errors/{code}
- How long the log keeps messages for this projectget/messages/retention
- Inbox message retention setput/messages/retention
- Inbox message test eventpost/messages/test-event
- Inbox message usageget/messages/usage
- Inbox message getget/messages/{id}
- Inbox message replaypost/messages/{id}/replay
- Mail, messages and calls in one listget/workspace/inbox
- Accept or dismiss an AI proposalpost/workspace/inbox/ai/items/{id}
- Whether an AI model is connected for the inboxget/workspace/inbox/ai/status
- The people and agents a conversation can be assigned toget/workspace/inbox/assignees
- The bytes of an attachment, as a download (a picture can be shown inline)get/workspace/inbox/attachments/{id}/download
- Inbox delivery reportpost/workspace/inbox/delivery-events
- Inbox draft listget/workspace/inbox/drafts
- Inbox draft createpost/workspace/inbox/drafts
- One draftget/workspace/inbox/drafts/{id}
- Save a draft as it is writtenput/workspace/inbox/drafts/{id}
- Throw a draft awaydelete/workspace/inbox/drafts/{id}
- Attach a file (base64, at most 20 MB, 25 MB and 20 files per message) to a draftpost/workspace/inbox/drafts/{id}/attachments
- Take a file off a draftdelete/workspace/inbox/drafts/{id}/attachments/{attId}
- Bring a scheduled message back as a draftpost/workspace/inbox/drafts/{id}/cancel-schedule
- Put a draft forward for a person to check and sendpost/workspace/inbox/drafts/{id}/request-send
- Send a draft later (a minute to a year ahead)post/workspace/inbox/drafts/{id}/schedule
- Send a draft after an undo window of up to 30 secondspost/workspace/inbox/drafts/{id}/send
- Translate what is being writtenpost/workspace/inbox/drafts/{id}/translate
- Send the original instead of the translationdelete/workspace/inbox/drafts/{id}/translate
- Inbox export mailboxget/workspace/inbox/export
- Take chosen conversations out as mbox, .eml files in a zip or a CSVpost/workspace/inbox/export
- Counts for the railget/workspace/inbox/folders
- Labels the caller can use: the workspace's and their ownget/workspace/inbox/labels
- Make a label, shared or personalpost/workspace/inbox/labels
- Rename or recolour a labelpatch/workspace/inbox/labels/{id}
- Delete a label; conversations keep their messagesdelete/workspace/inbox/labels/{id}
- Whether a mailbox is ready to send for realget/workspace/inbox/mailbox-readiness
- Inbox mailbox settingsget/workspace/inbox/mailbox-settings
- Inbox mailbox configureput/workspace/inbox/mailbox-settings
- Conversations that name the caller in a noteget/workspace/inbox/mentions
- Mark mentions seen, all or for one conversationpost/workspace/inbox/mentions/seen
- Inbox outbox listget/workspace/inbox/outbox
- Queue a held message again (after sending is turned on or the project goes live)post/workspace/inbox/outbox/{id}/retry
- Take back a message still inside its undo window; it returns as a draftpost/workspace/inbox/outbox/{id}/undo
- The caller's own desk settings: undo window, density, default signatureget/workspace/inbox/prefs
- Change the caller's own desk settingsput/workspace/inbox/prefs
- The caller's remindersget/workspace/inbox/reminders
- Cancel a reminderdelete/workspace/inbox/reminders/{id}
- Inbox retention getget/workspace/inbox/retention
- Change how long the desk keeps them (owner or manager)put/workspace/inbox/retention
- Rules that run on every message that arrives, in orderget/workspace/inbox/rules
- Make a rule (owner or manager)post/workspace/inbox/rules
- Which rules would fire on a conversation, and what they would dopost/workspace/inbox/rules/preview
- Run the rules again over chosen conversations (owner or manager)post/workspace/inbox/rules/run
- Change a rulepatch/workspace/inbox/rules/{id}
- Remove a ruledelete/workspace/inbox/rules/{id}
- A search written back in words, with the parts that were not understoodget/workspace/inbox/search/explain
- Senders let in or kept out by address or domainget/workspace/inbox/senders
- Allow or block a sender or domain, or clear the rule (owner or manager)put/workspace/inbox/senders
- Signatures: the workspace's and the caller's ownget/workspace/inbox/signatures
- Inbox signature createpost/workspace/inbox/signatures
- Change a signaturepatch/workspace/inbox/signatures/{id}
- Remove a signaturedelete/workspace/inbox/signatures/{id}
- Response targets and how the desk is doing against them over thirty daysget/workspace/inbox/sla
- Inbox sla setput/workspace/inbox/sla
- Remove a response targetdelete/workspace/inbox/sla
- Addresses the desk will not send to, and whyget/workspace/inbox/suppressed
- Put an address on the do-not-send listpost/workspace/inbox/suppressed
- Take an address off the do-not-send listdelete/workspace/inbox/suppressed
- Read new mail from the project's mailboxes into the inboxpost/workspace/inbox/sync
- Canned replies, most used firstget/workspace/inbox/templates
- Make a canned reply with {{customer.first_name}}-style variablespost/workspace/inbox/templates
- Change a canned replypatch/workspace/inbox/templates/{id}
- Remove a canned replydelete/workspace/inbox/templates/{id}
- Fill a canned reply for a conversationpost/workspace/inbox/templates/{id}/render
- Inbox desk threadsget/workspace/inbox/threads
- Inbox desk actpost/workspace/inbox/threads/act
- Empty the trashpost/workspace/inbox/threads/delete-forever
- Put labels on and take labels off a set of conversationspost/workspace/inbox/threads/labels
- Put conversations into one; the others are hidden and can be pulled back outpost/workspace/inbox/threads/merge
- Mark conversations read or unread for the callerpost/workspace/inbox/threads/read
- Mark everything in a folder read for the callerpost/workspace/inbox/threads/read-all
- Star or unstar conversations for the callerpost/workspace/inbox/threads/star
- One conversation with every message, note and draftget/workspace/inbox/threads/{id}
- Change one conversation: status, assignee, snooze, archivepatch/workspace/inbox/threads/{id}
- Inbox ai getget/workspace/inbox/threads/{id}/ai
- Propose a category, sentiment and languagepost/workspace/inbox/threads/{id}/ai/classify
- Draft a reply from what the project's memory knows, citing the passages it usedpost/workspace/inbox/threads/{id}/ai/suggest-reply
- Summarise a conversation. A proposal, marked as AIpost/workspace/inbox/threads/{id}/ai/summarize
- Translate a received messagepost/workspace/inbox/threads/{id}/messages/{turnId}/translate
- Write an internal note on a conversationpost/workspace/inbox/threads/{id}/notes
- Edit a note (its author or a manager)patch/workspace/inbox/threads/{id}/notes/{turnId}
- Delete a note (its author or a manager)delete/workspace/inbox/threads/{id}/notes/{turnId}
- Who else is viewing or replying to a conversation right nowget/workspace/inbox/threads/{id}/presence
- Inbox presence heartbeatpost/workspace/inbox/threads/{id}/presence
- Inbox reminder setpost/workspace/inbox/threads/{id}/remind
- Split a conversation at a messagepost/workspace/inbox/threads/{id}/split
- Pull a merged conversation back outpost/workspace/inbox/threads/{id}/unmerge
- Take back a batch of changes the caller made within the last hourpost/workspace/inbox/undo
- Saved views: searches kept by name, shared or personalget/workspace/inbox/views
- Save a search as a viewpost/workspace/inbox/views
- Rename a view or change its searchpatch/workspace/inbox/views/{id}
- Remove a viewdelete/workspace/inbox/views/{id}
- Run a saved viewget/workspace/inbox/views/{id}/threads
- The messaging inboxesget/workspace/inboxes
- Make an inbox for the website widgetpost/workspace/inboxes
- Change an inbox or its autonomy modepatch/workspace/inboxes/{id}
- Delete an inboxdelete/workspace/inboxes/{id}
- The threads of an inboxget/workspace/inboxes/{id}/threads
- Inbox mailbox listget/workspace/mailboxes
- Make a mailbox inside the planpost/workspace/mailboxes
- Whether an address can be made nowget/workspace/mailboxes/available
- Mail domains and their verificationget/workspace/mailboxes/domains
- Add a mail domainpost/workspace/mailboxes/domains
- Check a domain's DNS recordspost/workspace/mailboxes/domains/{domain}/verify
- The standard shared mailboxes the edition offers and which are already madeget/workspace/mailboxes/offers
- Rename a mailbox, or change who reads a shared one and where it routespatch/workspace/mailboxes/{id}
- Release a mailbox and free its slotdelete/workspace/mailboxes/{id}
- The mail of a mailbox as a file, to keep before it is releasedget/workspace/mailboxes/{id}/export
- One thread with its messagesget/workspace/threads/{id}
- Close a threadpost/workspace/threads/{id}/close
- Answer a thread, or keep the answer as a draftpost/workspace/threads/{id}/say