> For the complete documentation index, see [llms.txt](https://postman-v2.guides.gov.sg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://postman-v2.guides.gov.sg/endpoints-for-api-users/single-send.md).

# Single Send

{% hint style="danger" %}
We will be updating our response payload to include a `creatorId` field from **24 Feb 2025**. Please read the last section to find out where the amendment is and update your own systems if necessary, **before 24 Feb 2025.**
{% endhint %}

{% hint style="warning" %}
If you are sending time-sensitive, critical SMSes like OTPs or weather alerts, please use the single send API.
{% endhint %}

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.

{% hint style="info" %}
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`.
{% endhint %}

{% code title="Endpoint #1" overflow="wrap" %}

```
POST /campaigns/:campaignId/messages
```

{% endcode %}

{% code title="Example request body" overflow="wrap" %}

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

{% endcode %}

**\[Now to 26 Jan 2025] Example response body**

{% code title="Example response body" overflow="wrap" %}

```json
{
    "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"
}
```

{% endcode %}

**\[From 24 Feb 2025] The `creatorId` field will be inserted in the response payload from 24 Feb 2025. Please amend your own code accordingly for**&#x20;

`"creatorId": "<USER_ID_OF_MESSAGE_CREATOR>"`

<figure><img src="https://862051585-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl3mC1ibWq8HG4BKl4qlL%2Fuploads%2FjdIUxQtdjLVZPPagTXJP%2FScreenshot%202025-01-16%20at%2011.35.22%E2%80%AFAM.png?alt=media&amp;token=f8a9c2b3-bcca-47b6-9452-3fdb563e27b2" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://postman-v2.guides.gov.sg/endpoints-for-api-users/single-send.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
