Catálogo de blocos de e-mail

Todos os tipos de bloco do documento de e-mail, com os campos, as regras e o bloco que nasce quando ele é adicionado.

Esta página é gerada a partir do próprio modelo do documento de e-mail, o mesmo que POST /email/designs, PUT /email/designs/{designId} e as campanhas validam. Para entender o documento como um todo, leia antes o guia E-mail marketing.

Índice

BlocoTipoEntra em colunas
TítuloheadingSim
TextotextSim
BotãobuttonSim
ImagemimageSim
DivisordividerSim
EspaçospacerSim
ColunascolumnsNão
Redes sociaissocialSim
RodapéfooterNão

Campos de todo bloco

CampoTipoRegra
idtextoIdentificador do bloco, único no documento inteiro (colunas incluídas): até 64 caracteres entre letras, números, _ e -.
kindtextoO tipo do bloco. Só o objeto de propriedades com o mesmo nome do tipo pode vir preenchido.
paddingtextoEspaçamento interno: s, m ou l. Vazio usa m no corpo e s dentro de colunas.
background_colortextoCor de fundo do bloco em hexadecimal (#rgb ou #rrggbb).

Título (heading)

Um título de uma linha, em três níveis de tamanho.

As propriedades vão no objeto heading do bloco.

CampoTipoRegra
texttextoO texto do título, até 200 caracteres. Aceita merge tags.
levelinteiroO nível do título: 1, 2 ou 3.
aligntextoAlinhamento: left, center ou right.
colortextoCor do texto em hexadecimal.

Exemplo:

{
  "id": "titulo",
  "kind": "heading",
  "heading": {
    "text": "Olá, {{first_name|cliente}}",
    "level": 1,
    "align": "center"
  }
}

Texto (text)

Parágrafos de texto com trechos em negrito, itálico, sublinhado e links.

As propriedades vão no objeto text do bloco.

CampoTipoRegra
paragraphslista de objetosOs parágrafos do bloco. Precisa de ao menos um; o texto somado de todos os trechos vai até 5.000 caracteres.
paragraphs[].runslista de objetosOs trechos do parágrafo, na ordem.
paragraphs[].runs[].texttextoO texto do trecho, que não pode ser vazio. Aceita merge tags.
paragraphs[].runs[].boldbooleanoNegrito.
paragraphs[].runs[].italicbooleanoItálico.
paragraphs[].runs[].underlinebooleanoSublinhado.
paragraphs[].runs[].linkobjetoLink do trecho.
paragraphs[].runs[].link.hreftextoEndereço http, https, mailto ou tel, até 2.048 caracteres. Aceita merge tags.
aligntextoAlinhamento: left, center ou right.

Exemplo:

{
  "id": "texto",
  "kind": "text",
  "text": {
    "paragraphs": [
      {
        "runs": [
          {
            "text": "Aproveite "
          },
          {
            "text": "30% de desconto",
            "bold": true
          },
          {
            "text": " até domingo. "
          },
          {
            "text": "Veja as regras",
            "link": {
              "href": "https://loja.exemplo.com/regras"
            }
          }
        ]
      }
    ]
  }
}

Botão (button)

Um botão com link.

As propriedades vão no objeto button do bloco.

CampoTipoRegra
labeltextoO texto do botão, até 80 caracteres. Aceita merge tags.
hreftextoEndereço http, https, mailto ou tel, até 2.048 caracteres. Aceita merge tags.
aligntextoAlinhamento: left, center ou right.
full_widthbooleanoO botão ocupa a largura toda do bloco.
colortextoCor do botão em hexadecimal. Vazio usa button_color das configurações.
text_colortextoCor do texto do botão em hexadecimal. Vazio usa button_text_color das configurações.

Exemplo:

{
  "id": "botao",
  "kind": "button",
  "button": {
    "label": "Comprar agora",
    "href": "https://loja.exemplo.com/ofertas",
    "align": "center"
  }
}

Imagem (image)

Uma imagem servida por HTTPS, com link opcional.

As propriedades vão no objeto image do bloco.

CampoTipoRegra
srctextoEndereço https da imagem, até 2.048 caracteres.
alttextoTexto alternativo, até 300 caracteres. Aceita merge tags.
hreftextoLink opcional da imagem, com as mesmas regras do link do botão.
widthinteiroLargura em porcentagem da área disponível do bloco, de 10 a 100.
aligntextoAlinhamento: left, center ou right.

Exemplo:

{
  "id": "imagem",
  "kind": "image",
  "image": {
    "src": "https://loja.exemplo.com/banner.png",
    "alt": "Vitrine da semana",
    "href": "https://loja.exemplo.com",
    "width": 100
  }
}

Divisor (divider)

Uma linha horizontal.

As propriedades vão no objeto divider do bloco.

CampoTipoRegra
colortextoCor da linha em hexadecimal.
thicknessinteiroEspessura da linha em pixels, de 1 a 8.

Exemplo:

{
  "id": "divisor",
  "kind": "divider",
  "divider": {
    "color": "#e5e7eb",
    "thickness": 1
  }
}

Espaço (spacer)

Um espaço vazio de altura fixa. Não aceita padding.

As propriedades vão no objeto spacer do bloco.

CampoTipoRegra
heightinteiroAltura em pixels, de 4 a 120.

Exemplo:

{
  "id": "espaco",
  "kind": "spacer",
  "spacer": {
    "height": 24
  }
}

Colunas (columns)

Duas ou três colunas lado a lado, cada uma com a própria lista de blocos.

As propriedades vão no objeto columns do bloco.

CampoTipoRegra
ratiotextoA divisão da largura: 50-50, 33-67 ou 67-33 (duas colunas) ou 33-33-33 (três colunas). O número de colunas precisa bater com a divisão.
columnslista de objetosAs colunas, da esquerda para a direita.
columns[].blockslista de blocosOs blocos da coluna. Dentro de colunas não entram outras colunas nem o rodapé.

Exemplo:

{
  "id": "colunas",
  "kind": "columns",
  "columns": {
    "ratio": "50-50",
    "columns": [
      {
        "blocks": [
          {
            "id": "foto",
            "kind": "image",
            "image": {
              "src": "https://loja.exemplo.com/produto.png",
              "alt": "Produto",
              "width": 100
            }
          }
        ]
      },
      {
        "blocks": [
          {
            "id": "chamada",
            "kind": "button",
            "button": {
              "label": "Ver produto",
              "href": "https://loja.exemplo.com/produto"
            }
          }
        ]
      }
    ]
  }
}

Redes sociais (social)

Uma linha de links para redes sociais.

As propriedades vão no objeto social do bloco.

CampoTipoRegra
linkslista de objetosOs links. Precisa de ao menos um.
links[].networktextoA rede: facebook, instagram, linkedin, x, youtube, tiktok, whatsapp ou website.
links[].urltextoEndereço https do perfil.
links[].labeltextoTexto do link, até 50 caracteres. Vazio usa o nome da rede (ou o domínio, em website). Aceita merge tags.
aligntextoAlinhamento: left, center ou right.

Exemplo:

{
  "id": "redes",
  "kind": "social",
  "social": {
    "links": [
      {
        "network": "instagram",
        "url": "https://instagram.com/lojaexemplo"
      },
      {
        "network": "website",
        "url": "https://loja.exemplo.com",
        "label": "Nosso site"
      }
    ],
    "align": "center"
  }
}

Rodapé (footer)

O rodapé obrigatório com o nome e o endereço da empresa. Nas campanhas, o servidor acrescenta o link de descadastro logo abaixo.

As propriedades vão no objeto footer do bloco.

CampoTipoRegra
company_nametextoNome da empresa, obrigatório, até 200 caracteres. Aceita merge tags.
addresstextoEndereço da empresa, obrigatório, até 300 caracteres. Aceita merge tags.
texttextoTexto livre acima do nome, até 1.000 caracteres. Aceita merge tags.

Exemplo:

{
  "id": "rodape",
  "kind": "footer",
  "footer": {
    "company_name": "Loja Exemplo",
    "address": "Rua das Flores, 100, São Paulo, SP"
  }
}

Configurações do documento

O objeto settings vale para o e-mail inteiro. Todos os campos são opcionais; as cores seguem o formato hexadecimal dos blocos.

CampoTipoRegra
widthinteiroLargura máxima do e-mail em pixels, de 480 a 720. Vazio usa 600.
background_colortextoCor de fundo atrás do e-mail.
content_background_colortextoCor de fundo da área do conteúdo.
text_colortextoCor do texto.
link_colortextoCor dos links.
button_colortextoCor padrão dos botões.
button_text_colortextoCor padrão do texto dos botões.
font_familytextoA família de fontes, uma das listadas abaixo.
preheadertextoTexto de pré-visualização mostrado pela caixa de entrada ao lado do assunto, até 200 caracteres. Aceita merge tags. Nas campanhas, o preheader da campanha, quando preenchido, substitui este.

Famílias de fontes aceitas em font_family: inter, arial, georgia, helvetica, verdana, trebuchet.

Os valores usados quando um campo de settings fica vazio:

{
  "width": 600,
  "background_color": "#f4f4f5",
  "content_background_color": "#ffffff",
  "text_color": "#1f2937",
  "link_color": "#2563eb",
  "button_color": "#2563eb",
  "button_text_color": "#ffffff",
  "font_family": "arial"
}