Skip to main content

POST /bulk/:job_id

POSThttps://api.courier.com/bulk/:job_id
Ingest user data into a Bulk Job
PATH PARAMS
job_idstringrequired
A unique identifier representing the bulk job
BODY PARAM
usersarrayrequired
User data ingestion for the job
Responses
AUTH TOKEN
curl --request POST \
--url https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d \
--header 'Accept: application/json'
Response Example
{
"errors": [
{
"error": "Duplicate user",
"user": {
"email": "u1@courier.com",
"user_id": "u1",
"data": {
"recipientName": "Foo"
}
}
}
]
}

Example

Method: POST

URL: https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d

Body: ​

{
"users": [
{
"recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
"profile": {
"phone_number": "2025550125",
"email": "hello@example.com"
},
"data": {
"name": "Jane Doe",
"age": 27
},
"to": {
"email": "tejas@courier.com"
}
}
]
}