Postman v2 Guide
Go to Postman v2
  • Postman v2 API Docs
    • 🤖About Postman v2
      • Postman v2 SLOs
    • Postman v2 SMS API user documentation
    • 📶Service Status
    • ⏰Postman Guide latest updates
    • 🏋️Important dates
    • 🛒Useful Links
  • Postman v2 general user guide (MoP)
    • 🔐Logging into Postman v2
    • 📢Create Campaign
      • Message Preview
      • Language tab
      • Message content
      • Character count
    • 🪵Message Logs
    • Deleting campaigns
  • Postman v2 Admin Portal, for UI Users (MOP)
    • 📤Sending messages via the Admin Portal
  • Postman v2 Admin Portal for API users (MOP)
    • ⚙️Campaign Settings
    • 🖥️Sending Messages via Postman API
  • 🪪Sending SMSes using NRIC
  • Postman v2 admin portal, for UI users (Internal)
    • Internal SMS
    • Information for new Twilio users
    • Summary of Costs
    • How do I onboard Postman v2 Internal SMS
      • 1. Sender ID Registration
      • 2. Sign up for a Twilio account
      • 3. Set up your Twilio account
      • 4. Fill your Twilio credentials on Postman
        • What if I need to buy a phone number?
      • 5. Send a Test Message
  • General notes for API users
    • 🗒️Overview
    • Authentication
    • API Errors
    • Message Delivery Errors
    • Pagination
    • Rate Limits
  • Endpoints for API users
    • 📞Endpoints for API users
    • The message object
    • Single Send
    • Single Send - Retry
    • Retrieve Message
    • Batch Send
    • Batch Send - Retry
    • Retrieve Batch
    • Retrieve Campaign Message
  • SFTP
    • 📂SFTP Integration
    • 🗝️Generating SSH Keys
    • Connecting to the SFTP server
    • Sending messages via SFTP
    • Checking whether sending via SFTP is successful
  • Load Test
    • Load Test Booking Requirement
  • FAQ
    • ❓Postman v2 FAQ
      • General Q&A
      • Sending emails to users (Legacy Postman)
      • Access related inquiries
      • Platform access related inquiries
      • User Access
      • API keys generation and IP Address whitelisting
      • Delivery Report
      • Messaging
      • Message Statuses
      • Integration and configuration related inquiries
      • Delivery rate
      • File types
      • SFTP and other integration methods
    • 💻Postman v2 API FAQ
      • API keys generation
      • Campaign related inquiries
      • API related inquiries
      • IP Address related inquiries
    • 🗃️SFTP and Other integration methods
  • Legal
    • Terms & Condition
    • Privacy Policy
  • Call App
    • Terms & Condition
    • Privacy Policy
Powered by GitBook
On this page
Export as PDF
  1. Endpoints for API users

Batch Send - Retry

PreviousBatch SendNextRetrieve Batch

Last updated 11 months ago

Retries all failed messages that belongs to a batch. All messages that are retried will retain their original message ID.

The batch retry endpoint will only return a HTTP 201 response if

  1. the batch status is messages_enqueued or messages_enqueuing_failed.

Note that batch retry will fail if any of the messages that belongs to the batch has latestStatus of created. In this case, batch status will be set to messages_enqueuing_failed.

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

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

POST /campaigns/:campaignId/batch/:batchId/retry
Response Body
// This endpoint has no response body
// A HTTP 201 response will be returned if the batch retry is attempted.
Batch Send
Batch Send