Skip to main content

POST /send/list

POSThttps://api.courier.com/send/list
Send a notification to list(s) subscribers
BODY PARAM
ByList
liststringrequired
The list id intended to send.
eventstringrequired
A unique identifier that can be mapped to an individual Notification. This could be the "Notification ID” on Notification detail pages (see the Notifications page in the Courier app) or a custom string mapped to the event in settings.
brandstring
A unique identifier that represents the brand that should be used for rendering the notification.
datajson
An object that includes any data you want to pass to a message template. The data will populate the corresponding template variables.
overridejson
An object that is merged into the request sent by Courier to the provider to override properties or to gain access to features in the provider API that are not natively supported by Courier.
Responses
AUTH TOKEN
curl --request POST \
--url https://api.courier.com/send/list \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{}
'
Response Example
{
"messageId": "1-5e2b2615-05efbb3acab9172f88dd3f6f"
}