Skip to main content
POST
/
bulk
Create a bulk job
curl --request POST \
  --url https://api.courier.com/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": {
    "template": "<string>",
    "brand": "<string>",
    "data": {},
    "event": "<string>",
    "locale": {},
    "override": {}
  }
}'
{
  "jobId": "<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
  • InboundBulkMessage
  • InboundBulkMessage

Response

jobId
string
required