Send Email API
How to send emails via Postman's email API
Last updated
Was this helpful?
How to send emails via Postman's email API
Last updated
Was this helpful?
This section of the guide contains information on how our API to send email works. For detailed information, please follow the links at the end of this page.
This POST endpoint accepts a request body that contains information about the email to be sent. Each successful request to this endpoint will send a single email.
The request body can either be JSON or . The latter is required for .
Bearer Token
subject string (mandatory)
body string (mandatory)
recipient string (mandatory)
The email address of the recipient. Currently, we only support sending email to a single recipient (i.e. cc and bcc are not supported).
items string
items string
reply-to string
This sets the "Reply-To" email address, which allows sending an email from one email address and telling the recipients to reply to another address. If this field is omitted, it will default to the sender's email address.
This field accepts one of the following values:
URGENT
FOR_ACTION
FOR_INFO
attachments
For more detailed information, you can explore the links in the sidebar.
id: a unique identifier for the email, generated by Postman.
Users are strongly encouraged to save the id of their messages.
from string
If the from
attribute is not specified in your request, the response body will reflect the From address as Postman <info@mail.postman.gov.sg>
recipient string
The recipient that was specified in your request body
params object
The parameters of body
, from
and subject
as specified in your request body.
body string (mandatory)
from string
subject string (mandatory)
attachments_metadata nullable array of object
fileName string
fileSize number
hash string
status enum
The status of your message when you make a successful API call to our endpoints
UNSENT
Initial state of a newly created transactional email
ACCEPTED
Email has been accepted by our email provider
SENT
The send request was successfully forwarded to our email provider
Our email provider will attempt to deliver the message to the recipient's mail server
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 recipeint received the message and opened it in their email client
COMPLAINT
The email was successfully delivered to the reciepint's mail server, but the recipient marked it as spam
error_code
string will be filled if the status of your email is BOUNCED
Invalid from address
From address has not been verified
Blacklisted recipeint
If your status is not UNSENT
, this field will be null
.
error_sub_type
string will appear if the status of your email is BOUNCED
Hard Bounce
Soft Bounce
Complaint
If your status is not UNSENT
, this field will be null
.
created_at string (date-time)
updated_at nullable string (date-time)
accepted_at nullable string (date-time)
Will appear if the status of your message goes through ACCEPTED
sent_at nullable string (date-time)
Will appear if the status of your message goes through SENT
delivered_at nullable string (date-time)
Will appear if the status of your message goes through DELIVERED
opened_at nullable string (date-time)
Will appear if the status of your message goes through OPENED
This is the minimum required request body to send an email. The email will be sent from Postman.gov.sg <info@mail.postman.gov.sg>
.
In the event of a successful request, the response status code will be 201 Created
.
For unsuccessful requests, we will provide an appropriate status code and error message to indicate the reason for the failure.
A (non-exhaustive) list of reasons why a request may fail is as follows:
The request body is invalid because of missing mandatory fields or invalid field values. The error message will provide more details.
Internal server error. Unlike the previous reasons (which have a 4xx
error code), the error code for this will be 500
. (This is rare and unlikely to happen.)
Authorisation to Legacy Postman's API is performed with
.
The email address of the sender. If this field is omitted, the email will be sent from Postman <donotreply@mail.postman.gov.sg>
. For more information, .
For more information, .
This fields accept a user-defined string. For more information, .
This field accepts a list of attachments and is only available via multipart requests. For more information, .
The id can be used to check the status of the email via a separate endpoint that will return a similar JSON object. For more information, .
For general information about our API response formats, .
Sending emails is an asynchronous process. After receiving your API call, Postman will attempt to send the email via our email service provider. As such, a successful API request simply means the request has been made successfully. To return a response to each API call promptly, there is not enough time to ensure that your message has been sent or delivered successfully. To check on the status of your email, you should call .
The recipient has been blacklisted. For more information, .
The user has exceeded the rate limit. For more information, .
The subject or the body of the email is empty after applying .