Send a message

POST/v1/messages

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

channel_idstringrequired

Channel ID to send through

min length 1

contentanyrequired

Message content payload

conversation_idstring

Conversation ID (optional)

tostring

Recipient phone number

to_phonestring

Recipient phone number (alias for to)

typestringrequired

Message type (e.g. text, image, template)

min length 1

Responses

201Created

channel_idstringrequired

contentanyrequired

conversation_idstring | nullrequired

created_atstringrequired

delivered_atstring | nullrequired

directionstringrequired

errorstring | nullrequired

error_codestring | nullrequired

external_message_idstring | nullrequired

failed_atstring | nullrequired

idstringrequired

max_retriesinteger<int32>required

metadataanyrequired

organization_idstringrequired

provider_message_idstring | nullrequired

queued_atstring | nullrequired

read_atstring | nullrequired

reply_previewReplyPreviewItem

Show properties

has_resolved_contentbooleanrequired

message_idstring

provider_message_idstring

sender_labelstring

textstringrequired

retry_countinteger<int32>required

sender_phonestring | nullrequired

sending_atstring | nullrequired

sent_atstring | nullrequired

sent_bystring | nullrequired

sent_viastring | nullrequired

statusstringrequired

to_phonestringrequired

typestringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/messages" \
  -H "Content-Type: application/json" \
  -d '{
  "channel_id": "string",
  "content": "string",
  "conversation_id": "string",
  "to": "string",
  "to_phone": "string",
  "type": "string"
}'

const response = await fetch("/v1/messages", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "channel_id": "string",
  "content": "string",
  "conversation_id": "string",
  "to": "string",
  "to_phone": "string",
  "type": "string"
})
});

import requests

response = requests.post(
    "/v1/messages",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "channel_id": "string",
  "content": "string",
  "conversation_id": "string",
  "to": "string",
  "to_phone": "string",
  "type": "string"
},
)

Response

{
  "channel_id": "string",
  "content": "string",
  "conversation_id": "string",
  "created_at": "string",
  "delivered_at": "string",
  "direction": "string",
  "error": "string",
  "error_code": "string",
  "external_message_id": "string",
  "failed_at": "string",
  "id": "string",
  "max_retries": 0,
  "metadata": "string",
  "organization_id": "string",
  "provider_message_id": "string",
  "queued_at": "string",
  "read_at": "string",
  "reply_preview": {
    "has_resolved_content": true,
    "message_id": "string",
    "provider_message_id": "string",
    "sender_label": "string",
    "text": "string"
  },
  "retry_count": 0,
  "sender_phone": "string",
  "sending_at": "string",
  "sent_at": "string",
  "sent_by": "string",
  "sent_via": "string",
  "status": "string",
  "to_phone": "string",
  "type": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}