Skip to Content
Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference

Mailboxes

Mailboxes: endpoints, threads, messages, drafts, and governed sends. 58 endpoints under /v1/mailboxes.

Endpoints

EndpointWhat it does
GET /v1/mailboxesList mailboxes
POST /v1/mailboxesCreate a mailbox
DELETE /v1/mailboxes/{id}Delete a mailbox
GET /v1/mailboxes/{id}Get a mailbox
PATCH /v1/mailboxes/{id}Update a mailbox
GET /v1/mailboxes/{id}/actionsList mailbox actions
GET /v1/mailboxes/{id}/actions/{actionId}Get a mailbox action
POST /v1/mailboxes/{id}/actions/{actionId}/approveApprove a mailbox action
POST /v1/mailboxes/{id}/actions/{actionId}/cancelCancel a mailbox send
POST /v1/mailboxes/{id}/actions/{actionId}/denyDeny a mailbox action
POST /v1/mailboxes/{id}/actions/{actionId}/retryResume a mailbox send
GET /v1/mailboxes/{id}/agent-activityGet mailbox activity
GET /v1/mailboxes/{id}/draftsList drafts
POST /v1/mailboxes/{id}/draftsCreate a draft
DELETE /v1/mailboxes/{id}/drafts/{draftId}Delete a draft
GET /v1/mailboxes/{id}/drafts/{draftId}Get a draft
PATCH /v1/mailboxes/{id}/drafts/{draftId}Update a draft
POST /v1/mailboxes/{id}/drafts/{draftId}/sendSend a draft
POST /v1/mailboxes/{id}/endpointsAdd an endpoint to a mailbox
DELETE /v1/mailboxes/{id}/endpoints/{endpointId}Remove an endpoint from a mailbox
PATCH /v1/mailboxes/{id}/endpoints/{endpointId}Update a mailbox endpoint
GET /v1/mailboxes/{id}/eventsList mailbox events
GET /v1/mailboxes/{id}/foldersList mailbox folders
GET /v1/mailboxes/{id}/grantsList mailbox grants
POST /v1/mailboxes/{id}/grantsGrant a member access to a mailbox
DELETE /v1/mailboxes/{id}/grants/{grantId}Revoke a mailbox grant
PATCH /v1/mailboxes/{id}/grants/{grantId}Update a mailbox grant
GET /v1/mailboxes/{id}/labelsList mailbox labels
POST /v1/mailboxes/{id}/labelsCreate a mailbox label
DELETE /v1/mailboxes/{id}/labels/{labelId}Delete a mailbox label
PATCH /v1/mailboxes/{id}/labels/{labelId}Update a mailbox label
POST /v1/mailboxes/{id}/messagesSend a new message
GET /v1/mailboxes/{id}/messages/{messageId}Get a mailbox message
GET /v1/mailboxes/{id}/messages/{messageId}/attachments/{attachmentId}Get a message attachment
POST /v1/mailboxes/{id}/messages/{messageId}/attachments/{attachmentId}/copyCopy a message attachment
POST /v1/mailboxes/{id}/messages/{messageId}/discardDiscard a quarantined message
POST /v1/mailboxes/{id}/messages/{messageId}/forwardForward a message
GET /v1/mailboxes/{id}/messages/{messageId}/rawGet a message's raw MIME
POST /v1/mailboxes/{id}/messages/{messageId}/releaseRelease a quarantined message
POST /v1/mailboxes/{id}/messages/{messageId}/replyReply to a message
POST /v1/mailboxes/{id}/messages/{messageId}/reply-allReply to all recipients of a message
POST /v1/mailboxes/{id}/pausePause a mailbox
GET /v1/mailboxes/{id}/quarantineList quarantined messages
POST /v1/mailboxes/{id}/resumeResume a mailbox
GET /v1/mailboxes/{id}/threadsList threads in a mailbox
GET /v1/mailboxes/{id}/threads/{threadId}Get a mailbox thread
PATCH /v1/mailboxes/{id}/threads/{threadId}Update a mailbox thread
GET /v1/mailboxes/{id}/threads/{threadId}/contentRead a mailbox thread
DELETE /v1/mailboxes/{id}/threads/{threadId}/labelsRemove thread labels
POST /v1/mailboxes/{id}/threads/{threadId}/labelsAdd thread labels
GET /v1/mailboxes/{id}/threads/{threadId}/messagesList messages in a mailbox thread
GET /v1/mailboxes/{id}/threads/{threadId}/notesList notes in a mailbox thread
POST /v1/mailboxes/{id}/threads/{threadId}/notesCreate a mailbox note
DELETE /v1/mailboxes/{id}/threads/{threadId}/notes/{noteId}Delete a mailbox note
PATCH /v1/mailboxes/{id}/threads/{threadId}/notes/{noteId}Update a mailbox note
GET /v1/mailboxes/draftsList your drafts across mailboxes
GET /v1/mailboxes/needs-youList mailbox decisions awaiting you
GET /v1/mailboxes/threadsList threads across your mailboxes

Base URL, authentication, errors, and pagination are the same for every endpoint; see the REST API reference.

Related documentation

Update a conversation

Previous Page

Add thread labels

Next Page

On this page

Endpoints