Pular para o conteúdo principal
Referência da API

Campanhas

Campanhas para uma audiência: rascunho, teste, envio, pausa e série.

Listar campanhas

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

Parâ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

Resposta 200

broadcastsarray<object>obrigatório
Lista de broadcasts
nextCursorstringobrigatório
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. 9007199254740991obrigatório
Total de itens que batem com os filtros
pagination.pageintegermín. 0máx. 9007199254740991obrigatório
Página atual (começa em 1)
pagination.limitintegermín. 0máx. 9007199254740991obrigatório
Itens por página
pagination.totalPagesintegermín. 0máx. 9007199254740991obrigatório
Quantidade de páginas
pagination.totalIsEstimatebooleanobrigatório
true quando o total passa de 10000 e vem de estimativa

Criar campanha

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

Corpo da requisição

audienceIdstring (uuid)obrigatório
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

Resposta 201

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast

Obter campanha

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

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Resposta 200

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast
metricsobject
Métricas agregadas de entrega do broadcast
metrics.deliveredintegermín. 0máx. 9007199254740991obrigatório
Emails entregues
metrics.openedintegermín. 0máx. 9007199254740991obrigatório
Emails abertos ao menos uma vez
metrics.clickedintegermín. 0máx. 9007199254740991obrigatório
Emails com ao menos um clique
metrics.bouncedintegermín. 0máx. 9007199254740991obrigatório
Emails devolvidos (bounce)
metrics.failedintegermín. 0máx. 9007199254740991obrigatório
Emails com falha definitiva
metrics.suppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão

Editar rascunho

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

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Corpo da requisição

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

Resposta 200

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast

Enviar ou agendar campanha

POSThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/send200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Enviar teste da campanha

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

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Corpo da requisição

tostring (email)obrigatório
Endereço de e-mail para receber o teste
variablesobject
Valores simulados das variáveis para renderização no teste

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

Cancelar campanha

POSThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/cancel200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Resposta 200

idstring (uuid)obrigatório
Identificador único do broadcast
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast após o cancelamento
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado

Pausar campanha

POSThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/pause200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Resposta 200

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast

Retomar campanha

POSThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/resume200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Resposta 200

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast

Duplicar campanha

POSThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/duplicate201

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Resposta 201

idstring (uuid)obrigatório
Identificador único do broadcast
audienceIdstring (uuid)obrigatório
Identificador da audiência destinatária
audienceNamestringobrigatório
Nome da audiência destinatária
templateIdstring (uuid)obrigatório
Identificador do template usado no envio
subjectstringobrigatório
Assunto do e-mail
fromEmailstringobrigatório
Endereço de e-mail do remetente
replyTostringobrigatório
Endereço de e-mail para respostas
status"draft" | "scheduled" | "sending" | "paused" | "sent" | "failed" | "cancelled"obrigatório
Status atual do broadcast
scheduledAtstring (date-time)obrigatório
Data e hora agendadas para o envio
sentAtstring (date-time)obrigatório
Data e hora em que o envio foi concluído
cancelledAtstring (date-time)obrigatório
Data e hora em que o broadcast foi cancelado
recipientsTotalintegermín. 0máx. 9007199254740991obrigatório
Total de destinatários do broadcast
recipientsQueuedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários enfileirados para envio
recipientsFailedintegermín. 0máx. 9007199254740991obrigatório
Quantidade de destinatários com falha no envio
recipientsSuppressedintegermín. 0máx. 9007199254740991obrigatório
Destinatários pulados por supressão ou descadastro da categoria
subscriptionCategoryIdstring (uuid)obrigatório
Categoria de assinatura da campanha
createdAtstring (date-time)obrigatório
Data de criação do broadcast
updatedAtstring (date-time)obrigatório
Data da última atualização do broadcast

Série da campanha

GEThttps://api.coffeemail.com.br/v1/product/broadcasts/{id}/timeseries200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do broadcast

Parâmetros de consulta

hoursintegermín. 1máx. 168
Quantidade de horas a partir do início do envio

Resposta 200

startstring (date-time)obrigatório
Início do envio (primeiro e-mail criado); null antes de começar
pointsarray<object>obrigatório
Série por hora, acumulada