Sign in

v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB
Messages

Send a message

Sends a message to one or more recipients using a template. Supports multi-channel broadcast — when multiple channels are specified (e.g. ["sms", "whatsapp"]), a separate message is created for each (recipient, channel) pair. Returns immediately with per-recipient message IDs for async tracking via webhooks or the GET /messages/{id} endpoint.

post/v3/messages

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

tostring[] required

List of recipient phone numbers in E.164 format (multi-recipient fan-out)

channelstring[] nullable

Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel produces a separate message per recipient. "sent" = auto-detect. Defaults to ["sent"] (auto-detect) if omitted.

Example request

{
  "to": [
    "+14155551234",
    "+14155555678"
  ],
  "channel": [
    "sms",
    "whatsapp"
  ],
  "template": {
    "id": "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
    "name": "order_confirmation",
    "parameters": {
      "name": "John Doe",
      "order_id": "12345"
    }
  },
  "sandbox": false
}

Response

Message accepted for processing

successboolean

Indicates whether the request was successful