@spec templates_email_create_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

create-email-template

Create Email Template

Use this endpoint to create email templates on the Braze dashboard.

These templates will be available on the Templates & Media page. The response from this endpoint will include a field for email_template_id, which can be used to update the template in subsequent API calls.

Users’ email subscription status can be updated and retrieved via Braze using a RESTful API. You can use the API to set up bi-directional sync between Braze and other email systems or your own database. All API requests are made over HTTPS.

prerequisites

Prerequisites

To use this endpoint, you'll need an API key with the templates.email.create permission.

rate-limit

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

request-parameters

Request parameters

possible-errors

Possible errors

The following table lists possible returned errors and their associated troubleshooting steps, if applicable.

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec templates_email_info_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

see-email-template-information

See Email Template Information

Use this endpoint to get information on your email templates.

Important: Templates built using the drag-and-drop editor are not accepted.

prerequisites

Prerequisites

To use this endpoint, you'll need an API key with the templates.email.info permission.

rate-limit

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

response

Response

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"email_template_id": (string) Your email template's API Identifier,
"template_name": (string) The name of your email template,
"description": (string) The email template description,
"subject": (string) The email template subject line,
"preheader": (optional, string) The email preheader used to generate previews in some clients),
"body": (optional, string) The email template body that may include HTML,
"plaintext_body": (optional, string) A plaintext version of the email template body,
"should_inline_css": (optional, boolean) Whether there is inline CSS in the body of the template - defaults to the css inlining value for the workspace,
"tags": (string) Tag names,
"created_at": (string) The time the email was created at in ISO 8601,
"updated_at": (string) The time the email was updated in ISO 8601
}

Images in this response will show in the body variable as HTML.

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :Authorization (String.t):
  • :email_template_id (String.t): (Required) String See email template's API identifier.

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec templates_email_list_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

list-available-email-templates

List Available Email Templates

Use this endpoint to get a list of available templates in your Braze account.

prerequisites

Prerequisites

To use this endpoint, you'll need an API key with the templates.email.list permission.

rate-limit

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

response

Response

Important: Templates built using the drag-and-drop editor are not provided in this response.

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"count": number of templates returned
"templates": [template with the following properties]:
  "email_template_id": (string) your email template's API Identifier,
  "template_name": (string) the name of your email template,
  "created_at": (string, in ISO 8601),
  "updated_at": (string, in ISO 8601),
  "tags": (array of strings) tags appended to the template
}

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :Authorization (String.t):
  • :modified_after (String.t): (Optional) String in ISO 8601 Retrieve only templates updated at or after the given time.
  • :modified_before (String.t): (Optional) String in ISO 8601 Retrieve only templates updated at or before the given time.
  • :limit (integer()): (Optional) Positive Number Maximum number of templates to retrieve. Default to 100 if not provided, with a maximum acceptable value of 1000.
  • :offset (integer()): (Optional) Positive Number Number of templates to skip before returning rest of the templates that fit the search criteria.

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

@spec templates_email_update_post(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

update-email-template

Update Email Template

Use this endpoint 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 & Media page. The Create email template 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.

prerequisites

Prerequisites

To use this endpoint, you'll need an API key with the templates.email.update permission.

rate-limit

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

request-parameters

Request parameters

troubleshooting

Troubleshooting

The following table lists possible returned errors and their associated troubleshooting steps, if applicable.

parameters

Parameters

• connection (BrazeEx.Connection): Connection to server
• opts (keyword): Optional parameters
  • :"Content-Type" (String.t):
  • :Authorization (String.t):
  • :body (String.t):

returns

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure