POST
/
send
curl --request POST \
  --url https://api.courier.com/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": {
    "data": {},
    "brand_id": "<string>",
    "channels": {},
    "context": {
      "tenant_id": "<string>"
    },
    "metadata": {
      "event": "<string>",
      "tags": [
        "<string>"
      ],
      "utm": {
        "source": "<string>",
        "medium": "<string>",
        "campaign": "<string>",
        "term": "<string>",
        "content": "<string>"
      },
      "trace_id": "<string>"
    },
    "preferences": {
      "subscription_topic_id": "<string>"
    },
    "providers": {},
    "routing": {
      "method": "all",
      "channels": [
        {
          "channel": "<string>",
          "config": {},
          "method": "all",
          "providers": {},
          "if": "<string>"
        }
      ]
    },
    "timeout": {
      "provider": {},
      "channel": {},
      "message": 123,
      "escalation": 123,
      "criteria": "no-escalation"
    },
    "delay": {
      "duration": 123,
      "until": "<string>"
    },
    "expiry": {
      "expires_at": "<string>",
      "expires_in": "<string>"
    },
    "to": {
      "audience_id": "<string>",
      "data": {},
      "filters": [
        {
          "operator": "MEMBER_OF",
          "path": "account_id",
          "value": "<string>"
        }
      ]
    },
    "content": {
      "version": "<string>",
      "brand": "<any>",
      "elements": [
        {
          "type": "text",
          "channels": [
            "<string>"
          ],
          "ref": "<string>",
          "if": "<string>",
          "loop": "<string>",
          "content": "<string>",
          "align": "left",
          "text_style": "text",
          "color": "<string>",
          "bold": "<string>",
          "italic": "<string>",
          "strikethrough": "<string>",
          "underline": "<string>",
          "locales": {},
          "format": "markdown"
        }
      ]
    }
  }
}'
{
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
message
object
required

Defines the message to be delivered

Response

200 - application/json
requestId
string
required

A successful call to POST /send returns a 202 status code along with a requestId in the response body.

For send requests that have a single recipient, the requestId is assigned to the derived message as its message_id. Therefore the requestId can be supplied to the Message's API for single recipient messages.

For send requests that have multiple recipients (accounts, audiences, lists, etc.), Courier assigns a unique id to each derived message as its message_id. Therefore the requestId cannot be supplied to the Message's API for single-recipient messages.