Criar modelo de e-mail

post

/templates/email/create

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 inclui um campo para email_template_id, que pode ser usado para atualizar o modelo em chamadas subsequentes à API.

See me in Postman

Pré-requisitos

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

Limite de taxa

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

Corpo da solicitação

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

{
   "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

Parâmetro Obrigatória Tipo de dados Descrição

template_name Obrigatória String Nome de seu modelo de e-mail.

subject Obrigatória String Linha de assunto do modelo de e-mail.

body Obrigatória 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évias 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 app. Espera-se que seja um dos sites true ou false.

Exemplo de solicitação

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

Exemplo de resposta

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
  "email_template_id": "232b6d29-7e41-4106-a0ab-1c4fe915d701",
  "message": "success"
}

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. Digite 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.

O e-mail deve ter nomes de blocos de conteúdo válidos O e-mail pode conter blocos de conteúdo que não existem nesse ambiente.

Valor inválido para should_inline_css. Esperava-setrue ou false Esse parâmetro aceita apenas valores booleanos (verdadeiro ou falso). Certifique-se de que o valor de should_inline_css não esteja encapsulado entre aspas (""), o que faz com que o valor seja enviado como uma string.

Editar esta página no GitHub

QUÃO ÚTIL FOI ESTA PÁGINA?

Editar esta página no GitHub

New Stuff!