Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Mailboxes

Send a new message

Starts a new conversation from the mailbox's default From address.

POST
/v1/mailboxes/{id}/messages

Starts a new conversation from the mailbox's default From address. status is sent, or pending_approval when the caller's grant or a mailbox policy holds sends for a person's approval; a policy that denies sends refuses it with 403.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$

Header Parameters

idempotency-key?|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

to*array<string>
Items1 <= items
cc?array<string>|null
bcc?array<string>|null
replyTo?array<string>|null
subject*string
Length1 <= length
text?string|null
html?string|null
attachments?array<>|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/mailboxes/string/messages" \  -H "Content-Type: application/json" \  -d '{    "to": [      "string"    ],    "subject": "string"  }'
{  "actionId": "string",  "messageId": "string",  "threadId": "string",  "status": "sent",  "waitReason": "rate",  "reviewExpectedAt": "string",  "skippedRecipients": [    {      "address": "string",      "reason": "bounce",      "unsubscribeGroupId": "string"    }  ],  "createdAt": "string"}

Related documentation

Send a draft

Sends one of the caller's drafts: a reply draft in its thread, any other draft as a new conversation. A draft needs recipients, a subject, and a body.

Update a mailbox

Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key.