Single Send

We will be updating our response payload to include a creatorId field from 27 Jan 2025. Please read the last section to find out where the amendment is and update your own systems if necessary, before 27 Jan 2025.

If you are sending time-sensitive, critical SMSes like OTPs or weather alerts, please use the single send API.

The keys within the values object will vary depending on the campaign’s template parameters. To find out what the parameters for a template are, please refer to the template’s details in Postman’s web interface.

The response on whether the message was created will come in immediately. However, you will need to query the Retrieve message endpoint to get the message latestStatus.

Endpoint #1

POST /campaigns/:campaignId/messages

Example request body

{
  "recipient": "6599999999",
    "language": "english",
    "values": {
        // The following values are values for the parameters in the example template
        "name": "John Doe",
        "fruit": "apple"}
}

[Now to 26 Jan 2025] Example response body

Example response body

{
    "createdAt": "2024-01-29T17:39:35.574+08:00",
    "updatedAt": "2024-01-29T17:39:35.574+08:00",
    "id": "<YOUR_GENERATED_MESSAGE_ID>",
    "recipient": "6599999999",
    "values": {
        "name": "John Doe",
        "fruit": "apple"
    },
    "fullMessage": "<YOUR_FULL_MESSAGE>",
    "latestStatus": "created",
    "templateBodyId": "<YOUR_TEMPALTE_BODY_ID>",
    "campaignId": "<YOUR_CAMPAIGN_ID>",
    "language": "english"
}

[From 27 Jan 2025] The creatorId field will be inserted in the response payload from 27 Jan 2025. Please amend your own code accordingly for

"creatorId": "<USER_ID_OF_MESSAGE_CREATOR>"