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. Postman v2 API Docs

Postman Guide latest updates

Latest updates made to this document

Date
Pages
Updates

5 May 2025

21 Apr 2025

Release of endpoints

8 Apr 2025

Updated feature to support decommission of Notify

4 Apr 2025

Updated the Terms of Use

25 Feb 2025

Updated Default API Rate Limit to 10

18 Feb 2025

Restricted sensitive-normal data

10 Feb 2025

Details on blocking unsupported characters at the API layer Relevant API response error message

22 Jan 2025

What is load test and how can you book for load test

16 Jan 2025

Explanation of creatorId string

Inserted creatorId into new response payloads effective 24 Feb 2025

26 Dec 2024

How to delete campaigns

10 Dec 2024

How to identify your agency PIC(s)

26 Nov 2024

Postman's service status

Link to Policy Document - for users who need to identify root CAs

19 Nov 2024

Updated terminology Included more details on SLOs

14 Nov 2024

Updated our SLAs

12 Nov 2024

Campaign creation

Changed "full access" and "can send messages only" campaign role terms to "campaign owner" and "member" respectively

24 Oct 2024

Updates on retrying routing_error

30 Sep 2024

Updates on new estimated costs for SMS

18 Sep 2024

recipients: changed from string to numeric

17 Sep 2024

Updated link to access Legacy Postman to send emails out

How to format messages to contain commas, line breaks and quotation marks

Detailing error codes with troubleshooting steps, and introducing message_expired error code (release on 30 September 2024)

Book your TPS load test on Postman load test environment

Added "sent_at" and "delivered_at" fields to Retrieve Message API body.

21 Aug 2024

Updated consequence of using "fake" numbers

20 Aug 2024

Updated examples of successful and failed file uploads

2 Aug 2024

Adding and removing PIC(s)

Merged step 6 into step 4 as the information was repeated. Added some troubleshooting tips in step 5 .

2 Aug 2024

Removed 65 9999 9999 from example trigger conditions for recipient_invalid error code

24 Jul 2024

[25 Jul 2024] Fix deployed for Postman Policy guide. Please log in with your TechPass/agency email address to view.

16 Jul 2024

Updated with Postman's message segment calculator

4 Jul 2024

Updated SLA

2 Jul 2024

Do not use fake numbers to send SMSes for testing purposes

27 Jun 2024

Update on unsupported characters Update for corresponding status in dashboard

19 Jun 2024

success definition under From 31 May had errors but has since been amended.

12 Jun 2024

Removed 。 from unsupported characters list.

12 Jun 2024

Provided updates for Rate Limits and SLAs. Added more unsupported characters.

10 Jun 2024

Provided updates for Rate Limits and SLAs.

5 Jun 2024

Updated variables where variable content should not start or end with a space.

4 Jun 2024

New page how to switch sender IDs

30 May 2024

Added ` (backtick) to list of unsupported characters. Added list of unsupported characters to Message Content page

24 May 2024

Removal of Oracle guide on SSH Key generation

New commands to generate your SSH key pair Example of SSH keys

20 May 2024

Updated latest status

16 May 2024

Launch of Postman SFTP Production Site

Renamed Errors page to API Errors

Updated API response Updated status

New message objects for attempts

Updated with delivered

New page - errors

Updated API response

Updated API response

Updated API response

14 May 2024

Added Single and Batch Send Retry endpoints

Feature release: Campaign create access

3 May 2024

Removed Singpass login

Updated with Singpass login FAQ

26 Apr 2024

Updated criteria and examples where header name changes are permitted.

15 Apr 2024

8 Apr 2024

Added Terms & Condition and Privacy Policy

31 Mar 2024

Updated production base URL. Please note that message sending is currently unavailable.

SFTP is not available on Postman v2's production site until June 2024.

Updated conditions for agency's sender ID to appear under Postman v2's dropdown on production site.

21 Mar 2024

Created guide for admin portal users on sending internal messages

13 Mar 2024

Updated UI Training dates

8 Mar 2024

Do not conduct load testing on our test site

26 Feb 2024

General campaign creation guide for all users

Created message logs page

Created guide for admin portal users on sending messages

Updated FAQ

23 Feb 2024

SLAs for Postman v2.

Updated the SFTP documentation

FAQ updates

Added questions on SMS retry, priority tags, read statuses.

19 Feb 2024

Updated key types and info on IP address whitelisting

9 Feb 2024

Updated character count rules

Differences between admin and member access

Updated port number

29 Jan 2024

Actual rate limits will be released at a later date

Endpoints for API users

Updated full API payload for endpoints

Updated character count per message

23 Jan 2024

How to create line breaks in a message

Postman v2 Admin Portal for API users

Updated screens

22 Jan 2024

Created temporary sender name section

Updated production environment release dates

19 Jan 2024

Updated list of unsupported characters

Updated IP address whitelisting

16 Jan 2024

Updated SFTP Docs

11 Jan 2024

Training dates updated on MS Teams

8 Jan 2024

Postman API test environment is now live. This site is meant for API testing purpose only.

5 Jan 2024

Release of WOG BTN MS Teams channel

WOG BTN Teams channel set up for agency PICs

4 Jan 2024

Edited bulk to batch Edited endpoints containing word bulk to batch

31 Dec 2023

Postman test environment

We will be migrating our test environment domain, URL release will be shifted from 31 Dec 2023 to 8 Jan 2024

recipient string - Removed the + in front of the country code

Created the UI flow for API users - end goal for users to whitelist IP addresses and obtain API keys

20 Dec 2023

Updated workflow process

Removal of "Option 2"

Created page for updates to the API documents

Updated FAQ list

19 Dec 2023

18 Dec 2023

Updated FAQ list

16 Dec 2023

Released SFTP documentation

Updated FAQ list

PreviousService StatusNextImportant dates

Last updated 9 days ago

Direct users to Postman to detect unsupported characters and updated replacement suggestions.

No changes to the success definiiton in the table.

Updated with

Updated with

Updated

⏰
Authorised Sender ID Switch
Message delivery errors
Message content
message segment calculator
Sending SMS using NRIC
Sending SMS using NRIC
Terms of Use
Rate Limits
Blocking unsupported characters at the API layer
Load Test Booking Requirement
The message object
Single Send
Single Send - Retry
Retrieve Message
Retrieve Batch
Retrieve Campaign Message
Deleting Campaigns
Service Status
Postman Certificates
Postman v2 SLOs
Postman v2 SLAs
Message delivery errors
Estimated SMS costs
Sending emails to users (Legacy Postman)
Detailed explanation of error codes and new error code type: message_expired
Load test booking link
New fields to Retrieve Message API Body
Updates to using "fake" numbers
Checking whether sending via SFTP is successful
User Access
Fill your Twilio credentials on Postman
Message Delivery Error
Postman Policy Guide
Postman v2 SLAs
Do not use "fake" numbers as recipients
Rate Limits
SLAs
SFTP Integration
Generating SSH Keys
API Errors
Retrieve message
Retrieve batch
Retrieve campaign message
Single Send - Retry
Batch Send - Retry
Access related inquiries
Postman SFTP Integration Test
form link
Terms & Condition
Privacy Policy
Useful links
Postman v2's API Integration Test
SFTP on Production Site
Internal SMS
Important dates
Create campaign
Message Logs
Sending messages via the Admin Portal
Postman FAQ
SLAs
SFTP update
SFTP update
Character Count
Admin/member access
SFTP update
Rate Limits
The message object
SFTP Integration
Create message
Endpoints for API users
Batch Send
Retrieve Batch
Postman v2 admin portal
Create message workflow
API documents latest updates
Postman v2 SMS API FAQ
Retrieve Batch
Postman v2 SMS API FAQ
SFTP
Postman v2 SMS API FAQ
Rate Limits
Postman Data Security and Sensitivity classification
Postman SFTP Production Site Launch
Postman v2 Production site launch
Release of Postman test environment
The message object
Message Object
lateststatus string
The message object
The message object
Attempt array of objects
Latest status
The message object
Message Object
Message Content
Message Content
Message Object
Message Content
Message Object
Message Content
Message Object
Message Content
How do identify my agency PICs?
Create campaign
Temporary Sender Name
Create campaign - Temporary
sender name
Sending messages via the Admin Portal
Message Content
Character Count
Overview
Load testing information
Character Count
API users who do not want to manage your message templates within Postman
Important Dates
Integrations - IP address whitelisting
Changing your message header
Logging into Postman v2
Supported Query Parameters