Email templates

List, create, read, update and delete the email templates shared across the instance.

Email templates are the shared settings records for outgoing email, each with a name and a subject. You can list, create, read, update and delete them. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List email templates	GET	/settings/email_templates	Returns a page of email templates under data, with paging details under pagination.
Create an email template	POST	/settings/email_templates	Creates an email template and returns it under email_template.
Retrieve an email template	GET	/settings/email_templates/{email_template_id}	Returns one email template by its id, under email_template.
Delete an email template	DELETE	/settings/email_templates/{email_template_id}	Deletes an email template. The response has no body.
Update an email template	PATCH	/settings/email_templates/{email_template_id}	Changes the fields you send on an email template and returns it under email_template.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• name is required on a create. Send it, and usually a subject, under email_template.
• cc and bcc take lists of addresses. Send each as an array of strings.
• An email template id starts with et_.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the email template afterwards returns 404.