Single Send - Retry

Retries a single failed message. The message will retain the same message ID.

The message retry will only go through if:

  1. The message latestStatus is failure

  2. If the message belongs to a batch, the batch status is either messages_enqueued or messages_enqueuing_failed

After a message is retried, the message latestStatus will be set to created.

The Single Send - Retry feature behaves the same way as the Single Send feature.

Note that in your retry endpoint, the messageId remains the same, and is generated from the original request in your Single Send.

Endpoint #3
POST /campaigns/:campaignId/messages/:messageId/retry
Example response body
{
    "createdAt": "2024-05-16T16:48:42.247+08:00",
    "updatedAt": "2024-05-16T16:48:59.157+08:00",
    "id": "<YOUR_GENERATED_MESSAGE_ID>",
    "recipient": "6522222222",
    "values": {
        "name": "Emily Yeo"
    },
    "fullMessage": "This is a test message used for training purposes.\n\nOpen Government Products\n\n---\n\nThis is a message to Emily Yeo.\n\n---\n\nThis is an automated message sent by the Singapore Government.",
    "latestStatus": "created",
    "templateBodyId": "<YOUR_TEMPALTE_BODY_ID>",
	"campaignId": "<YOUR_CAMPAIGN_ID>"
}

Last updated