Audiences
Audit Events
AuthTokens
Inbound
Lists
Messages
Notifications
Profiles
Tenants
Translations
User Preferences
User Tenants
Bulk
Add users
POST
/
bulk
/
{job_id}
curl --request POST \
--url https://api.courier.com/bulk/{job_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"users": [
{
"preferences": {
"categories": {},
"notifications": {}
},
"profile": "<any>",
"recipient": "<string>",
"data": "<any>",
"to": {
"account_id": "<string>",
"context": {
"tenant_id": "<string>"
},
"data": {},
"email": "<string>",
"locale": "<string>",
"user_id": "<string>",
"phone_number": "<string>",
"preferences": {
"categories": {},
"notifications": {},
"templateId": "<string>"
},
"tenant_id": "<string>"
}
}
]
}'
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
A unique identifier representing the bulk job
Body
application/json
Use tenant_id
instad.
Context information such as tenant_id to send the notification with.
An id of a tenant, see tenants api docs. Will load brand, default preferences and any other base context data associated with this tenant.
The user's preferred ISO 639-1 language code.
An id of a tenant, see tenants api docs. Will load brand, default preferences and any other base context data associated with this tenant.
curl --request POST \
--url https://api.courier.com/bulk/{job_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"users": [
{
"preferences": {
"categories": {},
"notifications": {}
},
"profile": "<any>",
"recipient": "<string>",
"data": "<any>",
"to": {
"account_id": "<string>",
"context": {
"tenant_id": "<string>"
},
"data": {},
"email": "<string>",
"locale": "<string>",
"user_id": "<string>",
"phone_number": "<string>",
"preferences": {
"categories": {},
"notifications": {},
"templateId": "<string>"
},
"tenant_id": "<string>"
}
}
]
}'