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

Domínios

Cadastrar domínios, conferir DNS, DKIM, rastreio e aquecimento.

Listar domínios

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

Resposta 200

domainsarray<object>obrigatório
Lista de domínios cadastrados na organização
trackingDomainsAvailablebooleanobrigatório
Indica se a plataforma permite cadastrar um host de rastreamento próprio

Adicionar domínio

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

Corpo da requisição

namestring≥ 3≤ 253obrigatório
Nome do domínio a ser cadastrado para envio de emails
trackingDomain"custom" | "default"
custom cadastra links.<domínio> como host de rastreamento; default (padrão) usa o host da CoffeeMail

Resposta 201

idstring (uuid)obrigatório
Identificador único do domínio criado
namestringobrigatório
Nome do domínio cadastrado para envio de emails
status"pending" | "verified" | "failed"obrigatório
Situação inicial da verificação do domínio
dkimRecordsToPublisharray<object>obrigatório
Registros DNS que o cliente precisa publicar para ativar o domínio
trackingDomainobject
Host de rastreamento cadastrado quando trackingDomain = custom
trackingDomain.hoststringobrigatório
Host do domínio do cliente que precisa apontar para a plataforma
trackingDomain.targetstringobrigatório
Host da plataforma para onde o CNAME deve apontar
trackingDomain.verifiedbooleanobrigatório
Indica se o CNAME foi encontrado apontando para o alvo
trackingDomain.verifiedAtstring (date-time)obrigatório
Data e hora em que o CNAME foi confirmado
trackingDomain.recordobjectobrigatório
Registro CNAME a publicar

Obter domínio

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

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

idstring (uuid)obrigatório
Identificador único do domínio
namestringobrigatório
Nome do domínio cadastrado para envio de emails
status"pending" | "verified" | "failed"obrigatório
Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"obrigatório
Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
sendingIdentityobjectobrigatório
Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"obrigatório
Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"obrigatório
Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)obrigatório
Data e hora da última sincronização com o provedor de envio
dkimSelectorstringobrigatório
Seletor usado no registro DKIM do domínio
dkimPublicKeystringobrigatório
Chave pública DKIM gerada para o domínio
verifiedAtstring (date-time)obrigatório
Data e hora em que o domínio foi verificado
lastCheckAtstring (date-time)obrigatório
Data e hora da última verificação de DNS realizada
createdAtstring (date-time)obrigatório
Data e hora em que o domínio foi cadastrado
dnsRecordsToPublisharray<object>obrigatório
Registros DNS pendentes que o cliente precisa publicar
dkimRotationobjectobrigatório
Rotação de DKIM em andamento, ou null quando não há rotação pendente
dkimRotation.domainIdstring (uuid)obrigatório
Identificador único do domínio
dkimRotation.selectorstringobrigatório
Seletor DKIM pendente, que passa a valer após a propagação do DNS
dkimRotation.startedAtstring (date-time)obrigatório
Data e hora em que a rotação foi iniciada
dkimRotation.recordobjectobrigatório
Registro TXT que precisa ser publicado para concluir a rotação
returnPathobjectobrigatório
Return-path próprio (bounces.<domínio>), ou null quando a plataforma não oferece return-path
returnPath.hoststringobrigatório
Host do domínio do cliente que precisa apontar para a plataforma
returnPath.targetstringobrigatório
Host da plataforma para onde o CNAME deve apontar
returnPath.verifiedbooleanobrigatório
Indica se o CNAME foi encontrado apontando para o alvo
returnPath.verifiedAtstring (date-time)obrigatório
Data e hora em que o CNAME foi confirmado
returnPath.recordobjectobrigatório
Registro CNAME a publicar
trackingDomainobjectobrigatório
Host de tracking próprio do domínio, ou null quando não há host cadastrado ou o recurso está desligado
trackingDomain.hoststringobrigatório
Host do domínio do cliente que precisa apontar para a plataforma
trackingDomain.targetstringobrigatório
Host da plataforma para onde o CNAME deve apontar
trackingDomain.verifiedbooleanobrigatório
Indica se o CNAME foi encontrado apontando para o alvo
trackingDomain.verifiedAtstring (date-time)obrigatório
Data e hora em que o CNAME foi confirmado
trackingDomain.recordobjectobrigatório
Registro CNAME a publicar
trackingDomainsAvailablebooleanobrigatório
Indica se a plataforma permite cadastrar um host de tracking próprio
warningsarray<object>obrigatório
Avisos da última verificação de DNS; não mudam o status do domínio
checksobjectobrigatório
Status de cada registro DNS do domínio
checks.spfobjectobrigatório
checks.dkimobjectobrigatório
checks.dmarcobjectobrigatório
checks.ownershipobjectobrigatório
checks.returnPathobjectobrigatório
checks.trackingobjectobrigatório
trackingobjectobrigatório
Opções de rastreamento do domínio
tracking.opensbooleanobrigatório
Insere o pixel de abertura nos envios do domínio
tracking.clicksbooleanobrigatório
Reescreve os links para rastrear cliques
tracking.httpsbooleanobrigatório
Links e pixel rastreados usam https

Remover domínio

DELETEhttps://api.coffeemail.com.br/v1/product/domains/{id}200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Corpo da requisição

method"totp" | "password" | "email_token"obrigatório
Método usado para reautenticar antes de excluir o domínio
credentialstring≥ 1≤ 512obrigatório
Senha, código TOTP ou token enviado por email (conta sem senha nem MFA) para confirmar a exclusão

Verificar DNS

POSThttps://api.coffeemail.com.br/v1/product/domains/{id}/verify200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

idstring (uuid)obrigatório
Identificador único do domínio
namestringobrigatório
Nome do domínio verificado
status"pending" | "verified" | "failed"obrigatório
Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"obrigatório
Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
verifiedAtstring (date-time)obrigatório
Data e hora em que o domínio foi verificado com sucesso
checksobjectobrigatório
Resultados individuais de cada checagem de DNS realizada
checks.spfobjectobrigatório
Resultado da checagem do registro SPF
checks.dkimobjectobrigatório
Resultado da checagem do registro DKIM
checks.dmarcobjectobrigatório
Resultado da checagem do registro DMARC
checks.ownershipobjectobrigatório
Resultado da checagem de propriedade do domínio
checks.infrastructureSpfobject
Resultado da checagem do registro SPF Canônico de infraestrutura
requiredChecksarray<"spf" | "dkim" | "dmarc" | "ownership" | "infrastructureSpf">obrigatório
Checagens obrigatórias para considerar o domínio verificado
warningsarray<object>obrigatório
Avisos da última verificação de DNS; não mudam o status do domínio
sendingIdentityobjectobrigatório
Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"obrigatório
Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"obrigatório
Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)obrigatório
Data e hora da última sincronização com o provedor de envio

Checar saúde do domínio

POSThttps://api.coffeemail.com.br/v1/product/domains/{id}/health200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

domainIdstring (uuid)obrigatório
Identificador único do domínio
domainstringobrigatório
Nome do domínio verificado
status"healthy" | "warning" | "critical"obrigatório
Resultado geral da checagem de saúde do domínio
spfobjectobrigatório
Resultado da checagem do registro SPF
spf.okbooleanobrigatório
Indica se o registro SPF está correto
spf.expectedstringobrigatório
Valor esperado do registro SPF
spf.gotstringobrigatório
Valor do registro SPF encontrado no DNS
dkimobjectobrigatório
Resultado da checagem do registro DKIM
dkim.okbooleanobrigatório
Indica se o registro DKIM está correto
dkim.expectedstringobrigatório
Valor esperado do registro DKIM
dkim.gotstringobrigatório
Valor do registro DKIM encontrado no DNS
dmarcobjectobrigatório
Resultado da checagem do registro DMARC
dmarc.okbooleanobrigatório
Indica se o registro DMARC está correto
dmarc.expectedstringobrigatório
Valor esperado do registro DMARC
dmarc.gotstringobrigatório
Valor do registro DMARC encontrado no DNS
checkedAtstring (date-time)obrigatório
Data e hora em que a checagem foi realizada

Plano de aquecimento

GEThttps://api.coffeemail.com.br/v1/product/domains/{id}/warmup200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

domainIdstring (uuid)obrigatório
Identificador único do domínio
status"warming" | "completed"obrigatório
warming enquanto a rampa está ativa; completed quando terminou e não há mais limite
currentDayintegermín. 0máx. 9007199254740991obrigatório
Dia atual do período de aquecimento (warmup)
dailyQuotaintegermín. 0máx. 9007199254740991obrigatório
Limite diário de envios permitido para o dia atual
sentTodayintegermín. 0máx. 9007199254740991obrigatório
Quantidade de emails já enviados hoje
remainingTodayintegermín. 0máx. 9007199254740991obrigatório
Quantidade de envios restantes na cota diária
quotaUsedPercentintegermín. 0máx. 100obrigatório
Percentual da cota diária já utilizado
lastSendDatestringobrigatório
Data do último envio registrado para o domínio
totalDaysintegermín. 0máx. 9007199254740991obrigatório
Duração total da rampa de aquecimento, em dias
startedAtstring (date-time)obrigatório
Início do aquecimento (verificação do domínio)
completedAtstring (date-time)obrigatório
Quando o aquecimento terminou; nulo enquanto está em andamento

Rotacionar DKIM

POSThttps://api.coffeemail.com.br/v1/product/domains/{id}/dkim/rotate200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

domainIdstring (uuid)obrigatório
Identificador único do domínio
selectorstringobrigatório
Seletor DKIM pendente, que passa a valer após a propagação do DNS
startedAtstring (date-time)obrigatório
Data e hora em que a rotação foi iniciada
recordobjectobrigatório
Registro TXT que precisa ser publicado para concluir a rotação
record.type"TXT" | "CNAME"obrigatório
Tipo do registro DNS a ser publicado
record.hoststringobrigatório
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobrigatório
Valor que deve ser publicado no registro DNS
record.ttlintegermín. -9007199254740991máx. 9007199254740991
TTL em segundos sugerido para o registro
record.isInfrastructureboolean
Indica se o registro pertence à infraestrutura global da plataforma

Definir domínio de rastreio

PUThttps://api.coffeemail.com.br/v1/product/domains/{id}/tracking-domain200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Corpo da requisição

hoststring≥ 1≤ 253obrigatório
Subdomínio do domínio de envio usado nos links de abertura e clique

Resposta 200

hoststringobrigatório
Host do domínio do cliente que precisa apontar para a plataforma
targetstringobrigatório
Host da plataforma para onde o CNAME deve apontar
verifiedbooleanobrigatório
Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)obrigatório
Data e hora em que o CNAME foi confirmado
recordobjectobrigatório
Registro CNAME a publicar
record.type"TXT" | "CNAME"obrigatório
Tipo do registro DNS a ser publicado
record.hoststringobrigatório
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobrigatório
Valor que deve ser publicado no registro DNS
record.ttlintegermín. -9007199254740991máx. 9007199254740991
TTL em segundos sugerido para o registro
record.isInfrastructureboolean
Indica se o registro pertence à infraestrutura global da plataforma

Remover domínio de rastreio

DELETEhttps://api.coffeemail.com.br/v1/product/domains/{id}/tracking-domain200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Resposta 200

hoststringobrigatório
Host do domínio do cliente que precisa apontar para a plataforma
targetstringobrigatório
Host da plataforma para onde o CNAME deve apontar
verifiedbooleanobrigatório
Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)obrigatório
Data e hora em que o CNAME foi confirmado
recordobjectobrigatório
Registro CNAME a publicar
record.type"TXT" | "CNAME"obrigatório
Tipo do registro DNS a ser publicado
record.hoststringobrigatório
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobrigatório
Valor que deve ser publicado no registro DNS
record.ttlintegermín. -9007199254740991máx. 9007199254740991
TTL em segundos sugerido para o registro
record.isInfrastructureboolean
Indica se o registro pertence à infraestrutura global da plataforma

Ligar ou desligar rastreio

PATCHhttps://api.coffeemail.com.br/v1/product/domains/{id}/tracking200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador do domínio

Corpo da requisição

opensboolean
clicksboolean
httpsboolean

Resposta 200

opensbooleanobrigatório
Insere o pixel de abertura nos envios do domínio
clicksbooleanobrigatório
Reescreve os links para rastrear cliques
httpsbooleanobrigatório
Links e pixel rastreados usam https