Criar modelo de e-mail

Use esse endpoint para criar modelos de e-mail no dashboard do Braze.

Esses modelos estarão disponíveis na página Modelos e mídias. A resposta desse endpoint incluirá um campo para email_template_id, que pode ser usado para atualizar o modelo em chamadas subsequentes da API.

O status de inscrição de e-mail dos usuários pode ser atualizado e recuperado pela Braze usando uma API RESTful. Você pode usar a API para configurar a sincronização bidirecional entre o Braze e outros sistemas de e-mail ou seu próprio banco de dados. Todas as solicitações de API são feitas por HTTPS.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão templates.email.create.

Limite de taxa

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

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
8
9
{
   "template_name": (required, string) The name of your email template,
   "subject": (required, string) The email template subject line,
   "body": (required, 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,
   "should_inline_css": (optional, Boolean) If `true`, the `inline_css` feature is used on this template.
 }

Parâmetros de solicitação

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "template_name": "email_template_name",
  "subject": "Welcome to my email template!",
  "body": "This is the text within my email body and https://www.braze.com/ here is a link to Braze.com.",
  "plaintext_body": "This is the text within my email body and here is a link to https://www.braze.com/.",
  "preheader": "My preheader is pretty cool.",
  "tags": ["Tag1", "Tag2"]
}'

Possíveis erros

A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas, se aplicável.