Messages

Send a message

Sends a message on the requested channel and returns its receipt (id, status, and why it waits when it does) with a 201 Created status. Requires messages:create or the send permission of the channel it sends on, such as email:send. channel selects the payload variant. Repeating an identical request with the same optional Idempotency-Key header returns the original receipt; reusing the key for different content returns a conflict.

post/v1/messages

Request

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

Headers

idempotency-keystring nullable

Optional org-scoped key that makes a send idempotent. Repeating a request with the same key and identical payload replays the original 201 response; reusing the key with different content returns 409.

Request body

conversationIdstring
metadataMessageMetadata nullable
channel'email' required

Response

MessageReceipt

idstring required
status'pending' | 'scheduled' | 'queued' | 'processing' | 'sent' | 'delivered' | 'read' | 'failed' | 'bounced' | 'complained' 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
createdAtstring required

Changes

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