v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Email Templates

List email templates

Returns a cursor-paginated list of the account's email templates with each template's id, name, is_default flag, and category (for example HTML or Starting point).

Use a template's id as the email_template_id when creating or updating a broadcast. Note: templates in the Starting point category are generally not supported when creating broadcasts via the API — using one returns a Starting point email template is not supported error unless your app has been enabled for it. See Create a broadcast.

get/v4/email_templates

Query parameters

{"stackTrail":"paths:/v4/email_templates:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/email_templates:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/email_templates:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

Response

Returns a paginated list of all email templates for your account