Referencia de la API
Plantillas
Plantillas con borrador, publicación, versiones y vista previa.
Listar plantillas
GET
https://api.coffeemail.com.br/v1/product/templates200Respuesta 200
dataarray<object>obligatorio- Lista de templates de e-mail cadastrados
Crear plantilla
POST
https://api.coffeemail.com.br/v1/product/templates201Cuerpo de la solicitud
namestring≥ 1≤ 255obligatorio- 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≥ 1obligatorio- 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
Respuesta 201
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Obtener plantilla
GET
https://api.coffeemail.com.br/v1/product/templates/{id}200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Parámetros de consulta
draft"true" | "false"- true devolve o conteúdo do rascunho, quando existe
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Actualizar plantilla
PATCH
https://api.coffeemail.com.br/v1/product/templates/{id}200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Cuerpo de la solicitud
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
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Eliminar plantilla
DELETE
https://api.coffeemail.com.br/v1/product/templates/{id}204Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Guardar borrador
PUT
https://api.coffeemail.com.br/v1/product/templates/{id}/draft200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Cuerpo de la solicitud
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
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Descartar borrador
DELETE
https://api.coffeemail.com.br/v1/product/templates/{id}/draft200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Publicar plantilla
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/publish200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Cuerpo de la solicitud
messagestring≥ 1≤ 120- Título da versão publicada
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado
Vista previa
POST
https://api.coffeemail.com.br/v1/product/templates/preview200Cuerpo de la solicitud
htmlstring≥ 1obligatorio- 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
Respuesta 200
htmlstringobligatorio- HTML final renderizado da pré-visualização
textstringobligatorio- Versão em texto simples da pré-visualização
Formatear código
POST
https://api.coffeemail.com.br/v1/product/templates/format200Cuerpo de la solicitud
htmlstring≥ 1obligatorio- Código-fonte HTML ou JSX a ser formatado
format"html" | "react"- Formato do código de origem
Respuesta 200
htmlstringobligatorio- Código-fonte formatado
Renderizar con variables
POST
https://api.coffeemail.com.br/v1/product/templates/test-render200Cuerpo de la solicitud
htmlstring≥ 1obligatorio- 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
Respuesta 200
htmlstringobligatorio- HTML final renderizado e sanitizado
textstringobligatorio- Versão em texto simples do e-mail renderizado
sanitizeReportobjectobligatoriosanitizeReport.scriptsintegermín. 0máx. 9007199254740991obligatorio- Quantidade de tags <script> removidas
sanitizeReport.iframesintegermín. 0máx. 9007199254740991obligatorio- Quantidade de tags <iframe> removidas
sanitizeReport.javascriptHrefsintegermín. 0máx. 9007199254740991obligatorio- Quantidade de links javascript: removidos
sanitizeReport.eventHandlersintegermín. 0máx. 9007199254740991obligatorio- Quantidade de atributos de evento inline removidos
Enviar prueba de plantilla
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/test-send200Parámetros de ruta
idstring≥ 1obligatorio- Identificador ou alias do template
Cuerpo de la solicitud
tostring (email)obligatorio- 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
Respuesta 200
successbooleanobligatorio- Indica se o e-mail de teste foi despachado com sucesso
messageIdstringobligatorio- Identificador da mensagem gerada
recipientstring (email)obligatorio- E-mail do destinatário do teste
Listar versiones
GET
https://api.coffeemail.com.br/v1/product/templates/{id}/versions200Parámetros de ruta
idstring (uuid)obligatorio- 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
Respuesta 200
dataarray<object>obligatorio- Versões, da mais recente para a mais antiga
totalintegermín. -9007199254740991máx. 9007199254740991obligatorio- Total de versões do template
Obtener versión
GET
https://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}200Parámetros de ruta
idstring (uuid)obligatorio- Identificador do template
versionintegermín. 0máx. 9007199254740991obligatorio- Número da versão
Respuesta 200
versionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão, crescente a partir de 1
namestringobligatorio- Nome do template nesta versão
subjectstringobligatorio- Assunto do template nesta versão
createdBystring (uuid)obligatorio- Usuário que gerou a versão, ou null quando veio de API key
createdByNamestringobligatorio- Nome de quem gerou a versão, ou null quando veio de API key
messagestringobligatorio- Título da versão, quando informado
status"published" | "archived"obligatorio- published para a versão usada nos envios; archived para as anteriores
createdAtstring (date-time)obligatorio- Data em que a versão foi gravada
templateIdstring (uuid)obligatorio- Identificador do template
preheaderstringobligatorio- Preheader nesta versão
htmlstringobligatorio- HTML nesta versão
contentJsonobjectobligatorio- Estado do editor visual nesta versão
textPayloadstringobligatorio- Versão em texto simples nesta versão
variablesarray<object>obligatorio- Variáveis nesta versão
format"html" | "react"obligatorio- Formato do código-fonte nesta versão
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem nesta versão
Restaurar versión
POST
https://api.coffeemail.com.br/v1/product/templates/{id}/versions/{version}/restore200Parámetros de ruta
idstring (uuid)obligatorio- Identificador do template
versionintegermín. 0máx. 9007199254740991obligatorio- Número da versão
Parámetros de consulta
draft"true" | "false"- true restaura para um rascunho em vez de publicar na hora
Respuesta 200
idstring (uuid)obligatorio- Identificador único do template
organisationIdstring (uuid)obligatorio- Identificador da organização dona do template
namestringobligatorio- Nome do template
aliasstringobligatorio- Identificador amigável único para invocação via API ou SDK
subjectstringobligatorio- Assunto padrão do e-mail
preheaderstringobligatorio- Texto de pré-visualização na caixa de entrada
htmlstringobligatorio- Código-fonte HTML compilado do template
contentJsonobjectobligatorio- Estado estruturado da árvore de blocos visuais
textPayloadstringobligatorio- Versão em texto simples do template
variablesarray<object>obligatorio- Variáveis disponíveis para interpolação no template
isActivebooleanobligatorio- Indica se o template está ativo para uso
format"html" | "react"obligatorio- Formato do código-fonte do template
sourceLocale"pt-BR" | "en" | "es"obligatorio- Idioma de origem do conteúdo do template
createdAtstring (date-time)obligatorio- Data de criação do template
updatedAtstring (date-time)obligatorio- Data da última atualização do template
publishedVersionintegermín. -9007199254740991máx. 9007199254740991obligatorio- Número da versão publicada, usada nos envios; null se ainda não há versão
hasDraftbooleanobligatorio- Indica se há um rascunho salvo e ainda não publicado