Update Existing Email Templates

post

/templates/email/update

Use the Template REST APIs to programmatically manage the email templates that you have stored on the Braze dashboard, on the Templates & Media page. Braze provides two endpoints for creating and updating your email templates.

Use the endpoints below to update email templates on the Braze dashboard. You can access an email template’s email_template_id by navigating to it on the Templates and Media page. The email template creation API endpoint will also return an email_template_id reference.

All fields other than the email_template_id are optional, but you must specify at least one field to update.

Request Body

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
8
9
{
  "email_template_id": (required, string) your email template's API Identifier,
  "template_name": (optional, string) the name of your email template,
  "subject": (optional, string) the email template subject line,
  "body": (optional, string) the email template body that may include HTML,
  "plaintext_body": (optional, string) a plaintext version of the email template body,
  "preheader": (optional, string) the email preheader used to generate previews in some clients,
  "tags": (optional, array of Strings) Tags must already exist
}

Request Parameters

Parameter Required Data Type Description
email_template_id Required String Your email template’s API Identifier.
template_name Optional String The name of your email template
subject Optional String The email template subject line
body Optional String The email template body that may include HTML
plaintext_body Optional String A plaintext version of the email template body
preheader Optional String The email preheader used to generate previews in some clients
tags Optional String Tags must already exist

Request Components

Request Example

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "email_template_id": "ab1cde55-fg47-4h3i-8297-158jk3l2466m",
  "template_name": "Weekly Newsletter",
  "subject": "This Week'\''s Styles",
  "body": "Check out this week'\''s digital lookbook to inspire your outfits. Take a look at https://www.braze.com/",
  "plaintext_body": "This is the updated text within my email body and here is a link to https://www.braze.com/.",
  "preheader": "We want you to have the best looks this Summer",
  "tags": ["Tag1", "Tag2"]
}'

Possible Errors

  • Template Name is required

  • Tags must be an array.

  • All Tags must be Strings.

  • Some Tags could not be found.

WAS THIS PAGE HELPFUL?
New Stuff!