Postman Guide
Go to Postman v1
  • πŸ₯³About Postman v1 (Postman Legacy)
  • Campaign Guide - General
    • πŸš€How to send a campaign?
      • ☝️Before You Start
        • Demo Mode
  • Campaign Guide - Email
    • πŸ“§Email Campaigns - Basics
      • How do I send an email campaign?
      • Scheduled Sending
      • Bounced Emails and Halted Campaigns
      • Email Statistics
      • Formatting your Message Template
      • Variable Fields
      • Unique URL Link per Recipient
      • Pasting Content from Microsoft Word
      • Manage your Unsubscriptions
      • Understanding Unsubscriptions
    • πŸ”Sending Password-Protected Emails
      • Tutorial
      • Template Editor
  • Campaign Guide - SMS
    • πŸ“²SMS Campaigns - Basics
      • Before Starting Out
      • Summary of Costs
    • πŸͺœSMS Onboarding Overview
      • Step 1: Sender ID Registration
      • Step 2: Sign up for a Twilio account
      • Step 3: Set up your Twilio account
      • Step 4: Configure Your Twilio Account
        • What if I need to buy a phone number?
      • Step 5: Send a Test Message on Twilio
      • Step 6: Fill in your Twilio credentials in Postman!
        • How do I send a campaign with my saved SMS credentials?
    • πŸ€”What else do I need to know about sending SMSes?
      • More about Sender ID registration
      • Can I see the send status of my campaign?
      • How can I configure my SMS send rate?
      • Sending an SMS to a Foreign Number
      • SMS Best Practices
      • Useful Twilio Links
  • Campaign Guide - Telegram
    • πŸ€–Telegram Campaigns - Basics
      • How do I set up Telegram to send my campaigns?
      • Add Telegram Bot Token in Postman
      • Instructions for Recipient Onboarding
      • Use the Bot in the Campaign
      • Telegram Formatting
      • Telegram Bot Statistics
  • Email API Guide
    • πŸ“–Overview
      • IM8 Policies
      • Connecting your Intranet Application
      • API Response Formats
    • πŸ—οΈEmail API Key Management
      • Bearer Authentication
      • Generate your email API Key
      • Rotate your email API Key
    • πŸ“¨Programmatic Email API
      • Getting Started
      • Comparison with AMR
      • SG-Mail Whitelisting
      • Custom From Address
      • Tracking Email Status
      • Send Email API
        • From Name and From Address
        • CC and BCC
        • Recipient Blacklist
        • Email Tagging and Classification
        • Email Body
          • Embedding Images
            • Linked Images
            • Content-ID Images
        • Attachments
        • Rate Limit
      • Get Email by ID API
      • List Emails API
    • πŸ“¨Programmatic GovSG WhatsApp API
      • Getting Started
      • Tracking Message Status
      • Get Available Templates API
      • Send Message API
      • Get Message by ID API
      • List Messages API
    • πŸŽ“Frequently Asked Questions
  • FAQ
    • πŸ“ΆService Status
    • For Recipients
      • Check Email Authenticity
    • For Senders
      • Messaging Channel Comparison
      • Cost Breakdown
  • Legal
    • Terms & Conditions
    • Privacy Policy
  • Contact Us
  • GitHub
Powered by GitBook
On this page
  • Ready to onboard?
  • Step 1: Decide on a sender name and from address
  • Step 2: Understand what content you will be sending
  • Step 3: If you want to send the emails from your own custom sender email, contact Postman team here
  • Step 4: Generate API Key on Postman.gov.sg
  • Step 5: Start sending your test emails
  • Step 6: Communicate go-live date to Postman Team
  • Step 7: Tell us about your experience

Was this helpful?

  1. Email API Guide
  2. Programmatic Email API

Getting Started

This page gives you an overview of what to expect when onboarding to Postman Programmatic Email API. Onboarding is mostly self-service, with one exception listed below.

PreviousProgrammatic Email APINextComparison with AMR

Last updated 8 months ago

Was this helpful?

If you’re unsure if Postman Programmatic Email API is a good fit, get started by reading the following pages:

  • If you're an existing AMR user, you can check out this

  • Learn more about the relevant

  • Find out how to to our API

Ready to onboard?

Updated 26 September 2023: Postman will no longer be onboarding any new programmatic API users nor create new custom from addresses till further notice.

Here are the following steps to take note to help you onboard more smoothly.

Step 1: Decide on a sender name and from address

You can configure your from address to be either:

  • The default from address: info@mail.postman.gov.sg

  • A custom from address (e.g. hello@agency.gov.sg)

This decision will determine if you require our team's support to configure a custom from address. More info on this can be found .

Step 2: Understand what content you will be sending

To ensure that your content can be sent successfully, you should read these pages ahead of time.

Step 4: Generate API Key on Postman.gov.sg

Step 5: Start sending your test emails

As you integrate with the API:

Step 6: Communicate go-live date to Postman Team

Step 7: Tell us about your experience

Step 3: If you want to send the emails from your own custom sender email, contact Postman team

This step is optional, and only needed if you wish to set up a custom from address in .

Setting up custom sender email typically takes agencies up to 2 weeks to complete so make sure you add buffer time for this step. You may refer to for more details.

Log in to Postman.gov.sg using the sender email address identified in and generate the API Key. This API key will be used to authenticate your requests. You may follow the steps outlined .

If you wish to use a , please note that the email address with which you use to log into Postman must be the same as the address from which you wish to send emails.

Refer to the on how you can start sending your first email. Note the specific instructions on the , and .

Find out more about the

Understand you may encounter

If you need additional support, let us know your expected go-live date. If you have reached this step independently, do give us a heads up through before you go live.

We always strive to improve your user experience and it would mean a lot to us if you could take a few minutes to let us know how your experience was by filling in this .

πŸ“¨
comparison with AMR
IM8 Policies
connect your Intranet application
here
Are you sending any attachments?
Are you sending images?
Is the default send rate of 10 message/s sufficient for your use case?
here
this page
custom from address
steps here
email body
attachments
email tagging and classification
status codes and responses you may encounter
the various email statuses and error codes
this form
form
step 1
here
Step 1