Referencia de la API
Campañas
Campañas para una audiencia: borrador, prueba, envío, pausa y serie.
Listar campañas
GET
https://api.coffeemail.com.br/v1/product/broadcasts200Parámetros de consulta
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"- Filtra pelo status do broadcast
fromstring (date-time)- Data inicial do período de busca
tostring (date-time)- Data final do período de busca
afterstring≥ 1≤ 512- Cursor de paginação para buscar a próxima página
pageintegermín. 0máx. 100000- Página numerada (começa em 1). Ignorada quando `after` é enviado
limitintegermín. 0máx. 200- Quantidade máxima de broadcasts retornados
Respuesta 200
broadcastsarray<object>obligatorio- Lista de broadcasts
nextCursorstringobligatorio- Cursor para buscar a próxima página de resultados
paginationobject- Paginação numerada. Ausente quando a consulta usa cursor (`after`)
pagination.totalintegermín. 0máx. 9007199254740991obligatorio- Total de itens que batem com os filtros
pagination.pageintegermín. 0máx. 9007199254740991obligatorio- Página atual (começa em 1)
pagination.limitintegermín. 0máx. 9007199254740991obligatorio- Itens por página
pagination.totalPagesintegermín. 0máx. 9007199254740991obligatorio- Quantidade de páginas
pagination.totalIsEstimatebooleanobligatorio- true quando o total passa de 10000 e vem de estimativa
Crear campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts201Cuerpo de la solicitud
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
templateIdstring (uuid)- Identificador do template usado no envio
subjectstring≥ 1≤ 500- Assunto do e-mail
htmlstring≥ 1- Conteúdo HTML do e-mail
textstring- Conteúdo em texto puro do e-mail
fromEmailstring (email)- Endereço de e-mail do remetente (opcional só com status draft)
replyTostring (email)- Endereço de e-mail para respostas
scheduledAtstring (date-time)- Data e hora futuras para envio agendado (ISO 8601)
variablesobject- Variáveis usadas na personalização do template
status"draft"- draft salva um rascunho incompleto; os demais campos ficam opcionais
subscriptionCategoryIdstring (uuid)- Categoria de assinatura; quem se descadastrou dela é pulado
Respuesta 201
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
Obtener campaña
GET
https://api.coffeemail.com.br/v1/product/broadcasts/{id}200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Respuesta 200
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
metricsobject- Métricas agregadas de entrega do broadcast
metrics.deliveredintegermín. 0máx. 9007199254740991obligatorio- Emails entregues
metrics.openedintegermín. 0máx. 9007199254740991obligatorio- Emails abertos ao menos uma vez
metrics.clickedintegermín. 0máx. 9007199254740991obligatorio- Emails com ao menos um clique
metrics.bouncedintegermín. 0máx. 9007199254740991obligatorio- Emails devolvidos (bounce)
metrics.failedintegermín. 0máx. 9007199254740991obligatorio- Emails com falha definitiva
metrics.suppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão
Editar borrador
PATCH
https://api.coffeemail.com.br/v1/product/broadcasts/{id}200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Cuerpo de la solicitud
audienceIdstring (uuid)- Identificador da audiência destinatária
templateIdstring (uuid)- Template usado no envio
subjectstring≤ 500- Assunto do e-mail
htmlstring- Conteúdo HTML do e-mail
textstring- Conteúdo em texto puro do e-mail
fromEmailstring (email)- Endereço de e-mail do remetente
replyTostring (email)- Endereço de e-mail para respostas
scheduledAtstring (date-time)- Envio agendado (ISO 8601)
variablesobject- Variáveis usadas na personalização do template
subscriptionCategoryIdstring (uuid)- Categoria de assinatura da campanha
Respuesta 200
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
Enviar o programar campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/send200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Enviar prueba de campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/test-send200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Cuerpo de la solicitud
tostring (email)obligatorio- Endereço de e-mail para receber o teste
variablesobject- Valores simulados das variáveis para renderização no teste
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
Cancelar campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/cancel200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Respuesta 200
idstring (uuid)obligatorio- Identificador único do broadcast
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast após o cancelamento
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
Pausar campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/pause200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Respuesta 200
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
Reanudar campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/resume200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Respuesta 200
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
Duplicar campaña
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/duplicate201Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Respuesta 201
idstring (uuid)obligatorio- Identificador único do broadcast
audienceIdstring (uuid)obligatorio- Identificador da audiência destinatária
audienceNamestringobligatorio- Nome da audiência destinatária
templateIdstring (uuid)obligatorio- Identificador do template usado no envio
subjectstringobligatorio- Assunto do e-mail
fromEmailstringobligatorio- Endereço de e-mail do remetente
replyTostringobligatorio- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obligatorio- Status atual do broadcast
scheduledAtstring (date-time)obligatorio- Data e hora agendadas para o envio
sentAtstring (date-time)obligatorio- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obligatorio- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obligatorio- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obligatorio- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obligatorio- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obligatorio- Categoria de assinatura da campanha
createdAtstring (date-time)obligatorio- Data de criação do broadcast
updatedAtstring (date-time)obligatorio- Data da última atualização do broadcast
Serie de la campaña
GET
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/timeseries200Parámetros de ruta
idstring≥ 1obligatorio- Identificador do broadcast
Parámetros de consulta
hoursintegermín. 1máx. 168- Quantidade de horas a partir do início do envio
Respuesta 200
startstring (date-time)obligatorio- Início do envio (primeiro e-mail criado); null antes de começar
pointsarray<object>obligatorio- Série por hora, acumulada