Referência da API
Modelos
Modelos com rascunho, publicação, versões e prévia.
Listar modelos
GET
https://api.coffeemail.com.br/v1/product/templates200Resposta 200
dataarray<object>obrigatório- Lista de templates de e-mail cadastrados
Criar modelo
POST
https://api.coffeemail.com.br/v1/product/templates201Corpo da requisição
namestring≥ 1≤ 255obrigatório- 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≥ 1obrigatório- 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
Resposta 201
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Obter modelo
GET
https://api.coffeemail.com.br/v1/product/templates/{id}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Parâmetros de consulta
draft"true" | "false"- true devolve o conteúdo do rascunho, quando existe
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Atualizar modelo
PATCH
https://api.coffeemail.com.br/v1/product/templates/{id}200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Corpo da requisição
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
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Excluir modelo
DELETE
https://api.coffeemail.com.br/v1/product/templates/{id}204Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Salvar rascunho
PUT
https://api.coffeemail.com.br/v1/product/templates/{id}/draft200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Corpo da requisição
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
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Descartar rascunho
DELETE
https://api.coffeemail.com.br/v1/product/templates/{id}/draft200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Publicar modelo
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/publish200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Corpo da requisição
messagestring≥ 1≤ 120- Título da versão publicada
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado
Pré-visualizar
POST
https://api.coffeemail.com.br/v1/product/templates/preview200Corpo da requisição
htmlstring≥ 1obrigatório- 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
Resposta 200
htmlstringobrigatório- HTML final renderizado da pré-visualização
textstringobrigatório- Versão em texto simples da pré-visualização
Formatar código
POST
https://api.coffeemail.com.br/v1/product/templates/format200Corpo da requisição
htmlstring≥ 1obrigatório- Código-fonte HTML ou JSX a ser formatado
format"html" | "react"- Formato do código de origem
Resposta 200
htmlstringobrigatório- Código-fonte formatado
Renderizar com variáveis
POST
https://api.coffeemail.com.br/v1/product/templates/test-render200Corpo da requisição
htmlstring≥ 1obrigatório- 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
Resposta 200
htmlstringobrigatório- HTML final renderizado e sanitizado
textstringobrigatório- Versão em texto simples do e-mail renderizado
sanitizeReportobjectobrigatóriosanitizeReport.scriptsintegermín. 0máx. 9007199254740991obrigatório- Quantidade de tags <script> removidas
sanitizeReport.iframesintegermín. 0máx. 9007199254740991obrigatório- Quantidade de tags <iframe> removidas
sanitizeReport.javascriptHrefsintegermín. 0máx. 9007199254740991obrigatório- Quantidade de links javascript: removidos
sanitizeReport.eventHandlersintegermín. 0máx. 9007199254740991obrigatório- Quantidade de atributos de evento inline removidos
Enviar teste do modelo
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/test-send200Parâmetros do caminho
idstring≥ 1obrigatório- Identificador ou alias do template
Corpo da requisição
tostring (email)obrigatório- 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
Resposta 200
successbooleanobrigatório- Indica se o e-mail de teste foi despachado com sucesso
messageIdstringobrigatório- Identificador da mensagem gerada
recipientstring (email)obrigatório- E-mail do destinatário do teste
Listar versões
GET
https://api.coffeemail.com.br/v1/product/templates/{id}/versions200Parâmetros do caminho
idstring (uuid)obrigatório- Identificador do template
Parâmetros de consulta
limitintegermín. 0máx. 100- Quantidade de versões por página
offsetintegermín. 0máx. 9007199254740991- Deslocamento da página
Resposta 200
dataarray<object>obrigatório- Versões, da mais recente para a mais antiga
totalintegermín. -9007199254740991máx. 9007199254740991obrigatório- Total de versões do template
Obter versão
GET
https://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}200Parâmetros do caminho
idstring (uuid)obrigatório- Identificador do template
versionintegermín. 0máx. 9007199254740991obrigatório- Número da versão
Resposta 200
versionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão, crescente a partir de 1
namestringobrigatório- Nome do template nesta versão
subjectstringobrigatório- Assunto do template nesta versão
createdBystring (uuid)obrigatório- Usuário que gerou a versão, ou null quando veio de API key
createdByNamestringobrigatório- Nome de quem gerou a versão, ou null quando veio de API key
messagestringobrigatório- Título da versão, quando informado
status"published" | "archived"obrigatório- published para a versão usada nos envios; archived para as anteriores
createdAtstring (date-time)obrigatório- Data em que a versão foi gravada
templateIdstring (uuid)obrigatório- Identificador do template
preheaderstringobrigatório- Preheader nesta versão
htmlstringobrigatório- HTML nesta versão
contentJsonobjectobrigatório- Estado do editor visual nesta versão
textPayloadstringobrigatório- Versão em texto simples nesta versão
variablesarray<object>obrigatório- Variáveis nesta versão
format"html" | "react"obrigatório- Formato do código-fonte nesta versão
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem nesta versão
Restaurar versão
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}/restore200Parâmetros do caminho
idstring (uuid)obrigatório- Identificador do template
versionintegermín. 0máx. 9007199254740991obrigatório- Número da versão
Parâmetros de consulta
draft"true" | "false"- true restaura para um rascunho em vez de publicar na hora
Resposta 200
idstring (uuid)obrigatório- Identificador único do template
organisationIdstring (uuid)obrigatório- Identificador da organização dona do template
namestringobrigatório- Nome do template
aliasstringobrigatório- Identificador amigável único para invocação via API ou SDK
subjectstringobrigatório- Assunto padrão do e-mail
preheaderstringobrigatório- Texto de pré-visualização na caixa de entrada
htmlstringobrigatório- Código-fonte HTML compilado do template
contentJsonobjectobrigatório- Estado estruturado da árvore de blocos visuais
textPayloadstringobrigatório- Versão em texto simples do template
variablesarray<object>obrigatório- Variáveis disponíveis para interpolação no template
isActivebooleanobrigatório- Indica se o template está ativo para uso
format"html" | "react"obrigatório- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obrigatório- Idioma de origem do conteúdo do template
createdAtstring (date-time)obrigatório- Data de criação do template
updatedAtstring (date-time)obrigatório- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obrigatório- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobrigatório- Indica se há um rascunho salvo e ainda não publicado