Batch Send

Postman test site has a .csv file limit of 20 rows to ensure no load testing is done on this site. More information here on load testing.

Sends multiple messages in a single API request.

You will need to prepare a CSV file where, in addition to recipient and language, each column represents a value to the campaign’s template parameter.

Example CSV File

recipient,language,recipient_name,topic
6599999999,english,Emily Yeo,passport application #12345F
6599999998,chinese,James Tan,passport application #67890A

You will then need to upload this file to this endpoint.

To upload your file, send a multipart/form-data request to this endpoint.

Endpoint #4

POST /campaigns/:campaignId/batch/messages

If your client code is written in JavaScript, consider using a FormData object to contain your file (MDN Web API docs).

Example JavaScript code

// Assuming you have a constant or variable named "file" which is a File object:

const formData = new FormData();
formData.append("file", file);

const request = new XMLHttpRequest();
request.setRequestHeader("Authorization", "Bearer " + YOUR_API_KEY);
request.open(
  "POST",
  "https://<POSTMAN_V2_API_BASE_URL>/api/v2/campaigns/<YOUR_CAMPAIGN_ID>/batch/messages"
);

request.send(formData);

Response Body

{
    "isValid": true,
    "batchId": "<YOUR_BATCH_ID>"
}