Skip to content

Atualizar modelos de e-mail existentes

post

/templates/email/update

Use esse endpoint para atualizar modelos de e-mail no dashboard da Braze.

É possível acessar o email_template_id de um modelo de e-mail navegando até ele na página Modelos e mídia. O endpoint Criar modelo de e-mail também retornará uma referência email_template_id.

Todos os campos, exceto o email_template_id, são opcionais, mas você precisa especificar pelo menos um campo para atualizar.

See me in Postman

Pré-requisitos

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

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

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
10

{
  "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,
  "should_inline_css": (optional, Boolean) If `true`, the `inline_css` feature will be applied to the template.
}

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
email_template_id Obrigatória String O identificador de API do seu modelo de e-mail.
template_name Opcional String Nome do seu modelo de e-mail.
subject Opcional String Linha de assunto do modelo de e-mail.
body Opcional String Corpo do modelo de e-mail que pode incluir HTML.
plaintext_body Opcional String Uma versão em texto simples do corpo do modelo de e-mail.
preheader Opcional String Pré-cabeçalho de e-mail usado para gerar pré-visualizações em alguns clientes.
tags Opcional String As tags já devem existir.
should_inline_css Opcional booleano Ativa ou desativa o recurso inline_css por modelo. Se não for fornecido, a Braze usará a configuração padrão para o grupo de apps. Espera-se true ou false.

Exemplo de solicitação

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": "email_template_id",
  "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"]
}'

Solução de problemas

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

Erro Solução de problemas
É necessário informar o nome do modelo. Insira um nome de modelo.
As tags devem ser uma matriz. As tags devem ser formatadas como uma matriz de strings, por exemplo, ["marketing", "promotional", "transactional"].
Todas as tags devem ser strings. Confira se as tags estão entre aspas ("").
Algumas tags não puderam ser encontradas. Para adicionar uma tag ao criar um modelo de e-mail, a tag já deve existir na Braze.
Valor inválido para should_inline_css. Esperava-se true ou false. Esse parâmetro aceita apenas valores booleanos (true ou false). Certifique-se de que o valor de should_inline_css não esteja entre aspas (""), o que faz com que o valor seja enviado como uma string.
New Stuff!