# 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](/email-api-guide/programmatic-email-api/comparison-with-amr.md)
* Learn more about the relevant [IM8 Policies](/email-api-guide/overview/im8-policies.md)
* Find out how to [connect your Intranet application](/email-api-guide/overview/connecting-your-intranet-application.md) to our API

## Ready to onboard?

{% hint style="warning" %}
**Updated 26 September 2023:** Postman will no longer be onboarding any new programmatic API users nor create new custom from addresses 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: `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 [here](/email-api-guide/programmatic-email-api/custom-from-address.md).

### **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?](/email-api-guide/programmatic-email-api/send-email-api/attachments.md)
* [Are you sending images?](/email-api-guide/programmatic-email-api/send-email-api/email-body/embedding-images.md)
* [Is the default send rate of 10 message/s sufficient for your use case?](/email-api-guide/programmatic-email-api/send-email-api/rate-limit.md)

### **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](/email-api-guide/programmatic-email-api/custom-from-address.md) 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](/email-api-guide/api-key-management/generate-your-api-key.md).

{% hint style="info" %}
If you wish to use a [custom from address](/email-api-guide/programmatic-email-api/custom-from-address.md), 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](/email-api-guide/programmatic-email-api/send-email-api.md) on how you can start sending your first email. Note the specific instructions on the [email body](/email-api-guide/programmatic-email-api/send-email-api/email-body.md), [attachments](/email-api-guide/programmatic-email-api/send-email-api/attachments.md) and [email tagging and classification](/email-api-guide/programmatic-email-api/send-email-api/email-tagging-and-classification.md).

As you integrate with the API:

* Find out more about the [status codes and responses you may encounter](/email-api-guide/overview/api-response-formats.md)
* Understand [the various email statuses and error codes](/email-api-guide/programmatic-email-api/tracking-email-status.md) 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).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://postman-v1.guides.gov.sg/email-api-guide/programmatic-email-api/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.