API reference
Campaigns
Campaigns to an audience: draft, test, send, pause and time series.
List campaigns
GET
https://api.coffeemail.com.br/v1/product/broadcasts200Query parameters
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
Response 200
broadcastsarray<object>required- Lista de broadcasts
nextCursorstringrequired- 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. 9007199254740991required- Total de itens que batem com os filtros
pagination.pageintegermín. 0máx. 9007199254740991required- Página atual (começa em 1)
pagination.limitintegermín. 0máx. 9007199254740991required- Itens por página
pagination.totalPagesintegermín. 0máx. 9007199254740991required- Quantidade de páginas
pagination.totalIsEstimatebooleanrequired- true quando o total passa de 10000 e vem de estimativa
Create campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts201Request body
audienceIdstring (uuid)required- 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
Response 201
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
Get campaign
GET
https://api.coffeemail.com.br/v1/product/broadcasts/{id}200Path parameters
idstring≥ 1required- Identificador do broadcast
Response 200
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
metricsobject- Métricas agregadas de entrega do broadcast
metrics.deliveredintegermín. 0máx. 9007199254740991required- Emails entregues
metrics.openedintegermín. 0máx. 9007199254740991required- Emails abertos ao menos uma vez
metrics.clickedintegermín. 0máx. 9007199254740991required- Emails com ao menos um clique
metrics.bouncedintegermín. 0máx. 9007199254740991required- Emails devolvidos (bounce)
metrics.failedintegermín. 0máx. 9007199254740991required- Emails com falha definitiva
metrics.suppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão
Edit draft
PATCH
https://api.coffeemail.com.br/v1/product/broadcasts/{id}200Path parameters
idstring≥ 1required- Identificador do broadcast
Request body
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
Response 200
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
Send or schedule campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/send200Path parameters
idstring≥ 1required- Identificador do broadcast
Send campaign test
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/test-send200Path parameters
idstring≥ 1required- Identificador do broadcast
Request body
tostring (email)required- Endereço de e-mail para receber o teste
variablesobject- Valores simulados das variáveis para renderização no teste
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
Cancel campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/cancel200Path parameters
idstring≥ 1required- Identificador do broadcast
Response 200
idstring (uuid)required- Identificador único do broadcast
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast após o cancelamento
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
Pause campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/pause200Path parameters
idstring≥ 1required- Identificador do broadcast
Response 200
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
Resume campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/resume200Path parameters
idstring≥ 1required- Identificador do broadcast
Response 200
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
Duplicate campaign
POST
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/duplicate201Path parameters
idstring≥ 1required- Identificador do broadcast
Response 201
idstring (uuid)required- Identificador único do broadcast
audienceIdstring (uuid)required- Identificador da audiência destinatária
audienceNamestringrequired- Nome da audiência destinatária
templateIdstring (uuid)required- Identificador do template usado no envio
subjectstringrequired- Assunto do e-mail
fromEmailstringrequired- Endereço de e-mail do remetente
replyTostringrequired- Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"required- Status atual do broadcast
scheduledAtstring (date-time)required- Data e hora agendadas para o envio
sentAtstring (date-time)required- Data e hora em que o envio foi concluído
cancelledAtstring (date-time)required- Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991required- Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991required- Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991required- Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)required- Categoria de assinatura da campanha
createdAtstring (date-time)required- Data de criação do broadcast
updatedAtstring (date-time)required- Data da última atualização do broadcast
Campaign time series
GET
https://api.coffeemail.com.br/v1/product/broadcasts/{id}/timeseries200Path parameters
idstring≥ 1required- Identificador do broadcast
Query parameters
hoursintegermín. 1máx. 168- Quantidade de horas a partir do início do envio
Response 200
startstring (date-time)required- Início do envio (primeiro e-mail criado); null antes de começar
pointsarray<object>required- Série por hora, acumulada