Mailboxes

Send a new message

Starts a new conversation from the mailbox's default endpoint on the channel the body names (email when omitted); a mailbox with no endpoint on that channel is refused (422). A message to a number joins the mailbox's thread with that number when it has one. Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.

post/v1/mailboxes/{id}/messages

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}/messages
  • Auth: API key in header x-api-key

Path parameters

idstring required

Headers

idempotency-keystring nullable

Optional key that makes a mailbox send idempotent for the calling key or member. Repeating the request with the same key and body returns the original action in its current state. Keep the key after a lost response. Reusing it with different content returns 409. Active actions retain their key; terminal receipts remain replayable for 24 hours.

Request body

channel'email' nullable
tostring[] required
ccstring[] nullable
bccstring[] nullable
replyTostring[] nullable
subjectstring required
textstring nullable
htmlstring nullable

Response

MailboxSendReceipt

actionIdstring required
draftIdstring required
messageIdstring required
threadIdstring required
state'approvalRequired' | 'queued' | 'accepted' | 'completed' | 'notSent' | 'uncertain' required
acceptedAtstring nullable required
waitReason'rate' | 'daily-quota' | 'domain-health' | 'sending-paused' | 'upstream-unavailable' | 'retry' | 'campaign-paused' | 'domain-warming' | 'onboarding-review' | 'content-review' | 'screening-unavailable' nullable required
reviewExpectedAtstring nullable required
executeUntilstring nullable required
retryAtstring nullable required
retryEligibleboolean required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.