Skip to main content
API reference

Templates

Templates with drafts, publishing, versions and preview.

List templates

GEThttps://api.coffeemail.com.br/v1/product/templates200

Response 200

dataarray<object>required
Lista de templates de e-mail cadastrados

Create template

POSThttps://api.coffeemail.com.br/v1/product/templates201

Request body

namestring≥ 1≤ 255required
Nome do template
aliasstring≥ 1≤ 100
Identificador amigável único para invocação via API ou SDK
subjectstring≤ 255
Assunto padrão do e-mail
preheaderstring≤ 255
Texto de pré-visualização na caixa de entrada
htmlstring≥ 1required
Código-fonte HTML compilado do template
contentJsonobject
Estado estruturado da árvore de blocos visuais
textPayloadstring
Versão em texto simples do template
variablesarray<object>
Variáveis disponíveis para interpolação no template
format"html" | "react"
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"
Idioma de origem do conteúdo do template

Response 201

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Get template

GEThttps://api.coffeemail.com.br/v1/product/templates/{id}200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Query parameters

draft"true" | "false"
true devolve o conteúdo do rascunho, quando existe

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Update template

PATCHhttps://api.coffeemail.com.br/v1/product/templates/{id}200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Request body

namestring≥ 1≤ 255
Nome do template
aliasstring≥ 1≤ 100
Identificador amigável único para invocação via API ou SDK
subjectstring≤ 255
Assunto padrão do e-mail
preheaderstring≤ 255
Texto de pré-visualização na caixa de entrada
htmlstring≥ 1
Código-fonte HTML compilado do template
contentJsonobject
Estado estruturado da árvore de blocos visuais
textPayloadstring
Versão em texto simples do template
variablesarray<object>
Variáveis disponíveis para interpolação no template
format"html" | "react"
Formato do código-fonte do template
isActiveboolean
Indica se o template está ativo para uso
sourceLocale"pt-BR" | "en" | "es"
Idioma de origem do conteúdo do template
messagestring≥ 1≤ 120
Título da versão gerada por esta alteração

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Delete template

DELETEhttps://api.coffeemail.com.br/v1/product/templates/{id}204

Path parameters

idstring≥ 1required
Identificador ou alias do template

Save draft

PUThttps://api.coffeemail.com.br/v1/product/templates/{id}/draft200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Request body

namestring≥ 1≤ 255
Nome do template
aliasstring≥ 1≤ 100
Identificador amigável único para invocação via API ou SDK
subjectstring≤ 255
Assunto padrão do e-mail
preheaderstring≤ 255
Texto de pré-visualização na caixa de entrada
htmlstring≥ 1
Código-fonte HTML compilado do template
contentJsonobject
Estado estruturado da árvore de blocos visuais
textPayloadstring
Versão em texto simples do template
variablesarray<object>
Variáveis disponíveis para interpolação no template
format"html" | "react"
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"
Idioma de origem do conteúdo do template

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Discard draft

DELETEhttps://api.coffeemail.com.br/v1/product/templates/{id}/draft200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Publish template

POSThttps://api.coffeemail.com.br/v1/product/templates/{id}/publish200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Request body

messagestring≥ 1≤ 120
Título da versão publicada

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado

Preview

POSThttps://api.coffeemail.com.br/v1/product/templates/preview200

Request body

htmlstring≥ 1required
Código-fonte HTML ou JSX do template a pré-visualizar
format"html" | "react"
Formato do template de origem
variablesobject
Valores das variáveis usadas para popular o template

Response 200

htmlstringrequired
HTML final renderizado da pré-visualização
textstringrequired
Versão em texto simples da pré-visualização

Format code

POSThttps://api.coffeemail.com.br/v1/product/templates/format200

Request body

htmlstring≥ 1required
Código-fonte HTML ou JSX a ser formatado
format"html" | "react"
Formato do código de origem

Response 200

htmlstringrequired
Código-fonte formatado

Render with variables

POSThttps://api.coffeemail.com.br/v1/product/templates/test-render200

Request body

htmlstring≥ 1required
Código-fonte HTML ou JSX do template a pré-visualizar
format"html" | "react"
Formato do template de origem
variablesobject
Valores das variáveis usadas para popular o template

Response 200

htmlstringrequired
HTML final renderizado e sanitizado
textstringrequired
Versão em texto simples do e-mail renderizado
sanitizeReportobjectrequired
sanitizeReport.scriptsintegermín. 0máx. 9007199254740991required
Quantidade de tags <script> removidas
sanitizeReport.iframesintegermín. 0máx. 9007199254740991required
Quantidade de tags <iframe> removidas
sanitizeReport.javascriptHrefsintegermín. 0máx. 9007199254740991required
Quantidade de links javascript: removidos
sanitizeReport.eventHandlersintegermín. 0máx. 9007199254740991required
Quantidade de atributos de evento inline removidos

Send template test

POSThttps://api.coffeemail.com.br/v1/product/templates/{id}/test-send200

Path parameters

idstring≥ 1required
Identificador ou alias do template

Request body

tostring (email)required
Endereço de e-mail para receber o teste
fromstring (email)
Endereço do remetente (opcional)
subjectstring≤ 255
Sobrescrever o assunto no teste (opcional)
variablesobject
Valores simulados das variáveis para renderização no teste
draftboolean
true envia o conteúdo do rascunho, quando existe, em vez do publicado

Response 200

successbooleanrequired
Indica se o e-mail de teste foi despachado com sucesso
messageIdstringrequired
Identificador da mensagem gerada
recipientstring (email)required
E-mail do destinatário do teste

List versions

GEThttps://api.coffeemail.com.br/v1/product/templates/{id}/versions200

Path parameters

idstring (uuid)required
Identificador do template

Query parameters

limitintegermín. 0máx. 100
Quantidade de versões por página
offsetintegermín. 0máx. 9007199254740991
Deslocamento da página

Response 200

dataarray<object>required
Versões, da mais recente para a mais antiga
totalintegermín. -9007199254740991máx. 9007199254740991required
Total de versões do template

Get version

GEThttps://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}200

Path parameters

idstring (uuid)required
Identificador do template
versionintegermín. 0máx. 9007199254740991required
Número da versão

Response 200

versionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão, crescente a partir de 1
namestringrequired
Nome do template nesta versão
subjectstringrequired
Assunto do template nesta versão
createdBystring (uuid)required
Usuário que gerou a versão, ou null quando veio de API key
createdByNamestringrequired
Nome de quem gerou a versão, ou null quando veio de API key
messagestringrequired
Título da versão, quando informado
status"published" | "archived"required
published para a versão usada nos envios; archived para as anteriores
createdAtstring (date-time)required
Data em que a versão foi gravada
templateIdstring (uuid)required
Identificador do template
preheaderstringrequired
Preheader nesta versão
htmlstringrequired
HTML nesta versão
contentJsonobjectrequired
Estado do editor visual nesta versão
textPayloadstringrequired
Versão em texto simples nesta versão
variablesarray<object>required
Variáveis nesta versão
format"html" | "react"required
Formato do código-fonte nesta versão
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem nesta versão

Restore version

POSThttps://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}/restore200

Path parameters

idstring (uuid)required
Identificador do template
versionintegermín. 0máx. 9007199254740991required
Número da versão

Query parameters

draft"true" | "false"
true restaura para um rascunho em vez de publicar na hora

Response 200

idstring (uuid)required
Identificador único do template
organisationIdstring (uuid)required
Identificador da organização dona do template
namestringrequired
Nome do template
aliasstringrequired
Identificador amigável único para invocação via API ou SDK
subjectstringrequired
Assunto padrão do e-mail
preheaderstringrequired
Texto de pré-visualização na caixa de entrada
htmlstringrequired
Código-fonte HTML compilado do template
contentJsonobjectrequired
Estado estruturado da árvore de blocos visuais
textPayloadstringrequired
Versão em texto simples do template
variablesarray<object>required
Variáveis disponíveis para interpolação no template
isActivebooleanrequired
Indica se o template está ativo para uso
format"html" | "react"required
Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"required
Idioma de origem do conteúdo do template
createdAtstring (date-time)required
Data de criação do template
updatedAtstring (date-time)required
Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991required
Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanrequired
Indica se há um rascunho salvo e ainda não publicado