Audiences
AuthTokens
Brands
Inbound
Lists
Messages
Notifications
Profiles
Tenants
User Preferences
User Tenants
Send
Send a message
Use the send API to send a message to one or more recipients.
POST
/
send
Copy
Ask AI
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"
}
]
}
}
}'
Copy
Ask AI
{
"requestId": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200 - application/json
The response is of type object
.
Copy
Ask AI
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"
}
]
}
}
}'
Copy
Ask AI
{
"requestId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.