# Getting Started

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 [comparison with AMR](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/comparison-with-amr)
* Learn more about the relevant [IM8 Policies](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/overview/im8-policies)
* Find out how to [connect your Intranet application](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/overview/connecting-your-intranet-application) to our API

## Ready to onboard?

{% hint style="warning" %}
**Updated 26 September 2023:** Postman will no longer be onboarding any new programmatic email API user till further notice.
{% endhint %}

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: `donotreply@mail.postman.gov.sg`
* A custom from address (e.g. `noreply@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 [here](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/custom-from-address).

### **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.

* [Are you sending any attachments?](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/attachments)
* [Are you sending images?](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/email-body/embedding-images)
* [Is the default send rate of 10 message/s sufficient for your use case?](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/rate-limit)

### **Step 3: If you want to send the emails from your own custom sender email, contact Postman team** [**here**](https://go.gov.sg/postmanp-api-wogict)

This step is optional, and only needed if you wish to set up a custom from address in [step 1](#step-1-decide-on-a-sender-name-and-from-email-address).

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 [this page](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/custom-from-address) for more details.

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

Log in to Postman.gov.sg using the sender email address identified in [**Step 1**](#step-1-decide-on-a-sender-name-and-from-email-address) and generate the API Key. This API key will be used to authenticate your requests. You may follow the steps outlined [here](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/api-key-management/generate-your-api-key).

{% hint style="info" %}
If you wish to use a [custom from address](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/custom-from-address), 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.
{% endhint %}

### **Step 5: Start sending your test emails**

Refer to the [steps here](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api) on how you can start sending your first email. Note the specific instructions on the [email body](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/email-body), [attachments](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/attachments) and [email tagging and classification](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/send-email-api/email-tagging-and-classification).

As you integrate with the API:

* Find out more about the [status codes and responses you may encounter](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/overview/api-response-formats)
* Understand [the various email statuses and error codes](https://postman-v1.guides.gov.sg/~/changes/YeLkNyuQOW0qmXU37t7T/email-api-guide/programmatic-email-api/tracking-email-status) you may encounter

### **Step 6: Communicate go-live date to Postman Team**

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 [this form](https://go.gov.sg/postmanp-api-wogict) before you go live.

### **Step 7: Tell us about your experience**

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 [form](https://go.gov.sg/postman-api-feedback).