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
  • Email Status
  • Error Codes and Error Subtype
  • Error code while sending emails
  • Error code after an email has been sent
  • Tracking Open Rates

Was this helpful?

  1. Email API Guide
  2. Programmatic Email API

Tracking Email Status

PreviousCustom From AddressNextSend Email API

Last updated 8 months ago

Was this helpful?

API users can track the status of emails sent via our API.

We rely on Amazon SES's event tracking to update the status of emails sent via our API. This means that the status of emails sent via our API may not be updated in real-time and, depending on the settings of the recipient's email provider, this event tracking may be skewed. As such, the accuracy of our email status tracking is not guaranteed. For more information, please refer to .

Email Status

You can get the status of each email sent sent using .

For , email statuses are not tracked.

We currently do not support pushing webhooks to your server when the status of an email changes. We are exploring the possibility of providing more email analytics, such as monthly reports aggregating statistics about email deliverability grouped based on user-defined tags. For more information, see .

For a list of statuses supported by our API, please refer to the table below.

Status
Definition

UNSENT

Initial state of a newly created transactional email (this status is not returned in the course of a successful request to send an email)

ACCEPTED

Email has been accepted by our email provider (this status is returned in the course of a successful request to send an email)

SENT

The send request was successfully forwarded to our email provider and our email provider will attempt to deliver the message to the recipient’s mail server (API user can check this and all subsequent statuses via the /transactional/email/{emailId} endpoint)

BOUNCED

The recipient's mail server rejected the email

DELIVERED

The email provider has successfully delivered the email to the recipient's mail server

OPENED

The recipient received the message and opened it in their email client

Error Codes and Error Subtype

The errorCode and errorSubType fields in the JSON object returned supplement the email status and provide additional information.

You can find a non-exhaustive list of error codes below.

Error code while sending emails

  1. Invalid from address: the user has entered a from address that is neither their own (the email address used to log into Postman) nor <info@mail.postman.gov.sg>.

  2. From address has not been verified: the user should contact the Postman team to verify their from address.

Error code after an email has been sent

  1. Hard bounce: the recipient's mail server permanently rejected the email (e.g. the recipient's email address does not exist).

  2. Soft bounce: the recipient's mail server temporarily rejected the email (e.g. the recipient's mailbox is full).

  3. Complaint: the recipient has marked the email as spam.

For the error codes above, you can find more information by checking the errorSubType field.

Tracking Open Rates

To track open rates of emails, a 1 pixel by 1 pixel transparent GIF image is inserted in each email sent through Amazon SES and includes a unique reference to this image file; when the image is downloaded, SES can tell exactly which message was opened and by whom. In general, the addition of this tracking pixel does not change the appearance of your email. However, for Intranet recipients, this tracking pixel might be blocked and show up as a red cross. Currently, we do not support opting out of this tracking pixel.

Please note that for emails with CC and BCC recipients, the tracking pixel is not accurate as it will be triggered when any of the recipients open the email. This is an inherent limitation of the tracking pixel as the content of the email is identical for all recipients.

Blacklisted recipient: the recipient's email address is on our blacklist. For more information, see .

For more information, you can refer to .

πŸ“¨
this page
this API endpoint
CC and BCC recipients
this section
by our API
this section
this page