📧
Emails API
Sending emails via API is simple, fast, and easy. You no longer need to compose emails within your application code. Instead, create an Email Template in Send With SES dashboard. To send email just trigger that Email Template via an API call. Every email template has its own unique Secret Template Key which must be used when making the API call.
.png?alt=media&token=7d6b5bb5-442f-442d-b909-96883efaacba)
You will be shown the below screen ...
.png?alt=media&token=bec1534a-8f7e-4f8c-ae6e-7c9bbf00b079)
Give your template a name, select Format (Plain Text or HTML) and Type (Transactional or Marketing). On click 'Save' you are presented with a template which you can now customize as per your needs. Compose your email along with the appropriate REPLACE TAGS (aka Merge Tag). A REPLACE TAG is indicated by a unique name within double-curly-braces, like so ... {{password-reset-link}}. You can use as many REPLACE TAGS as needed. When sending email, the content within the double-curly-braces will be replaced by the content you send via your API call. Image below illustrates.
Click to enlarge.
Click "How To" button below the email template for instructions on how to make the API call. Every email template has its own unique Secret Template Key which must be used when making the API call. You can send an email to a single user or to multiple users (bulk email).
Email To Single User : Specify the email id of the user along with other POST Request Parameters (see Green Box in below image).
Email To Multiple Users : Your contacts will be filtered using the tags mentioned in your API call and an email will be sent to all of them (see Pink Box in below image).
.png?alt=media&token=9d0a28cc-fce7-41bb-96c2-f476d81f9972)
.png?alt=media&token=c14708a7-6813-4a15-a3c0-303e18ccccad)
Every API call returns a status code. Status Codes indicate whether an API operation is successful or not. A response code of 2xx indicates the operation was successful. Other error codes indicate either a client error (4xx) or a server error (5xx).
- For 4xx errors you must fix the POST Request and retry again.
- For 5xx errors retry the request until it succeeds.
Need help? Write to [email protected]
Last modified 1mo ago