API reference
Domains
Add domains, check DNS, DKIM, tracking and warm-up.
List domains
GET
https://api.coffeemail.com.br/v1/product/domains200Response 200
domainsarray<object>required- Lista de domínios cadastrados na organização
trackingDomainsAvailablebooleanrequired- Indica se a plataforma permite cadastrar um host de rastreamento próprio
Add domain
POST
https://api.coffeemail.com.br/v1/product/domains201Request body
namestring≥ 3≤ 253required- 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
Response 201
idstring (uuid)required- Identificador único do domínio criado
namestringrequired- Nome do domínio cadastrado para envio de emails
status"pending" | "verified" | "failed"required- Situação inicial da verificação do domínio
dkimRecordsToPublisharray<object>required- Registros DNS que o cliente precisa publicar para ativar o domínio
trackingDomainobject- Host de rastreamento cadastrado quando trackingDomain = custom
trackingDomain.hoststringrequired- Host do domínio do cliente que precisa apontar para a plataforma
trackingDomain.targetstringrequired- Host da plataforma para onde o CNAME deve apontar
trackingDomain.verifiedbooleanrequired- Indica se o CNAME foi encontrado apontando para o alvo
trackingDomain.verifiedAtstring (date-time)required- Data e hora em que o CNAME foi confirmado
trackingDomain.recordobjectrequired- Registro CNAME a publicar
Get domain
GET
https://api.coffeemail.com.br/v1/product/domains/{id}200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
idstring (uuid)required- Identificador único do domínio
namestringrequired- Nome do domínio cadastrado para envio de emails
status"pending" | "verified" | "failed"required- Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"required- Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
sendingIdentityobjectrequired- Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"required- Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"required- Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)required- Data e hora da última sincronização com o provedor de envio
dkimSelectorstringrequired- Seletor usado no registro DKIM do domínio
dkimPublicKeystringrequired- Chave pública DKIM gerada para o domínio
verifiedAtstring (date-time)required- Data e hora em que o domínio foi verificado
lastCheckAtstring (date-time)required- Data e hora da última verificação de DNS realizada
createdAtstring (date-time)required- Data e hora em que o domínio foi cadastrado
dnsRecordsToPublisharray<object>required- Registros DNS pendentes que o cliente precisa publicar
dkimRotationobjectrequired- Rotação de DKIM em andamento, ou null quando não há rotação pendente
dkimRotation.domainIdstring (uuid)required- Identificador único do domínio
dkimRotation.selectorstringrequired- Seletor DKIM pendente, que passa a valer após a propagação do DNS
dkimRotation.startedAtstring (date-time)required- Data e hora em que a rotação foi iniciada
dkimRotation.recordobjectrequired- Registro TXT que precisa ser publicado para concluir a rotação
returnPathobjectrequired- Return-path próprio (bounces.<domínio>), ou null quando a plataforma não oferece return-path
returnPath.hoststringrequired- Host do domínio do cliente que precisa apontar para a plataforma
returnPath.targetstringrequired- Host da plataforma para onde o CNAME deve apontar
returnPath.verifiedbooleanrequired- Indica se o CNAME foi encontrado apontando para o alvo
returnPath.verifiedAtstring (date-time)required- Data e hora em que o CNAME foi confirmado
returnPath.recordobjectrequired- Registro CNAME a publicar
trackingDomainobjectrequired- Host de tracking próprio do domínio, ou null quando não há host cadastrado ou o recurso está desligado
trackingDomain.hoststringrequired- Host do domínio do cliente que precisa apontar para a plataforma
trackingDomain.targetstringrequired- Host da plataforma para onde o CNAME deve apontar
trackingDomain.verifiedbooleanrequired- Indica se o CNAME foi encontrado apontando para o alvo
trackingDomain.verifiedAtstring (date-time)required- Data e hora em que o CNAME foi confirmado
trackingDomain.recordobjectrequired- Registro CNAME a publicar
trackingDomainsAvailablebooleanrequired- Indica se a plataforma permite cadastrar um host de tracking próprio
warningsarray<object>required- Avisos da última verificação de DNS; não mudam o status do domínio
checksobjectrequired- Status de cada registro DNS do domínio
checks.spfobjectrequiredchecks.dkimobjectrequiredchecks.dmarcobjectrequiredchecks.ownershipobjectrequiredchecks.returnPathobjectrequiredchecks.trackingobjectrequiredtrackingobjectrequired- Opções de rastreamento do domínio
tracking.opensbooleanrequired- Insere o pixel de abertura nos envios do domínio
tracking.clicksbooleanrequired- Reescreve os links para rastrear cliques
tracking.httpsbooleanrequired- Links e pixel rastreados usam https
Remove domain
DELETE
https://api.coffeemail.com.br/v1/product/domains/{id}200Path parameters
idstring≥ 1required- Identificador do domínio
Request body
method"totp" | "password" | "email_token"required- Método usado para reautenticar antes de excluir o domínio
credentialstring≥ 1≤ 512required- Senha, código TOTP ou token enviado por email (conta sem senha nem MFA) para confirmar a exclusão
Verify DNS
POST
https://api.coffeemail.com.br/v1/product/domains/{id}/verify200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
idstring (uuid)required- Identificador único do domínio
namestringrequired- Nome do domínio verificado
status"pending" | "verified" | "failed"required- Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"required- Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
verifiedAtstring (date-time)required- Data e hora em que o domínio foi verificado com sucesso
checksobjectrequired- Resultados individuais de cada checagem de DNS realizada
checks.spfobjectrequired- Resultado da checagem do registro SPF
checks.dkimobjectrequired- Resultado da checagem do registro DKIM
checks.dmarcobjectrequired- Resultado da checagem do registro DMARC
checks.ownershipobjectrequired- 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">required- Checagens obrigatórias para considerar o domínio verificado
warningsarray<object>required- Avisos da última verificação de DNS; não mudam o status do domínio
sendingIdentityobjectrequired- Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"required- Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"required- Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)required- Data e hora da última sincronização com o provedor de envio
Check domain health
POST
https://api.coffeemail.com.br/v1/product/domains/{id}/health200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
domainIdstring (uuid)required- Identificador único do domínio
domainstringrequired- Nome do domínio verificado
status"healthy" | "warning" | "critical"required- Resultado geral da checagem de saúde do domínio
spfobjectrequired- Resultado da checagem do registro SPF
spf.okbooleanrequired- Indica se o registro SPF está correto
spf.expectedstringrequired- Valor esperado do registro SPF
spf.gotstringrequired- Valor do registro SPF encontrado no DNS
dkimobjectrequired- Resultado da checagem do registro DKIM
dkim.okbooleanrequired- Indica se o registro DKIM está correto
dkim.expectedstringrequired- Valor esperado do registro DKIM
dkim.gotstringrequired- Valor do registro DKIM encontrado no DNS
dmarcobjectrequired- Resultado da checagem do registro DMARC
dmarc.okbooleanrequired- Indica se o registro DMARC está correto
dmarc.expectedstringrequired- Valor esperado do registro DMARC
dmarc.gotstringrequired- Valor do registro DMARC encontrado no DNS
checkedAtstring (date-time)required- Data e hora em que a checagem foi realizada
Warm-up plan
GET
https://api.coffeemail.com.br/v1/product/domains/{id}/warmup200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
domainIdstring (uuid)required- Identificador único do domínio
status"warming" | "completed"required- warming enquanto a rampa está ativa; completed quando terminou e não há mais limite
currentDayintegermín. 0máx. 9007199254740991required- Dia atual do período de aquecimento (warmup)
dailyQuotaintegermín. 0máx. 9007199254740991required- Limite diário de envios permitido para o dia atual
sentTodayintegermín. 0máx. 9007199254740991required- Quantidade de emails já enviados hoje
remainingTodayintegermín. 0máx. 9007199254740991required- Quantidade de envios restantes na cota diária
quotaUsedPercentintegermín. 0máx. 100required- Percentual da cota diária já utilizado
lastSendDatestringrequired- Data do último envio registrado para o domínio
totalDaysintegermín. 0máx. 9007199254740991required- Duração total da rampa de aquecimento, em dias
startedAtstring (date-time)required- Início do aquecimento (verificação do domínio)
completedAtstring (date-time)required- Quando o aquecimento terminou; nulo enquanto está em andamento
Rotate DKIM
POST
https://api.coffeemail.com.br/v1/product/domains/{id}/dkim/rotate200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
domainIdstring (uuid)required- Identificador único do domínio
selectorstringrequired- Seletor DKIM pendente, que passa a valer após a propagação do DNS
startedAtstring (date-time)required- Data e hora em que a rotação foi iniciada
recordobjectrequired- Registro TXT que precisa ser publicado para concluir a rotação
record.type"TXT" | "CNAME"required- Tipo do registro DNS a ser publicado
record.hoststringrequired- Nome do host/subdomínio onde o registro deve ser criado
record.valuestringrequired- 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
Set tracking domain
PUT
https://api.coffeemail.com.br/v1/product/domains/{id}/tracking-domain200Path parameters
idstring≥ 1required- Identificador do domínio
Request body
hoststring≥ 1≤ 253required- Subdomínio do domínio de envio usado nos links de abertura e clique
Response 200
hoststringrequired- Host do domínio do cliente que precisa apontar para a plataforma
targetstringrequired- Host da plataforma para onde o CNAME deve apontar
verifiedbooleanrequired- Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)required- Data e hora em que o CNAME foi confirmado
recordobjectrequired- Registro CNAME a publicar
record.type"TXT" | "CNAME"required- Tipo do registro DNS a ser publicado
record.hoststringrequired- Nome do host/subdomínio onde o registro deve ser criado
record.valuestringrequired- 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
Remove tracking domain
DELETE
https://api.coffeemail.com.br/v1/product/domains/{id}/tracking-domain200Path parameters
idstring≥ 1required- Identificador do domínio
Response 200
hoststringrequired- Host do domínio do cliente que precisa apontar para a plataforma
targetstringrequired- Host da plataforma para onde o CNAME deve apontar
verifiedbooleanrequired- Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)required- Data e hora em que o CNAME foi confirmado
recordobjectrequired- Registro CNAME a publicar
record.type"TXT" | "CNAME"required- Tipo do registro DNS a ser publicado
record.hoststringrequired- Nome do host/subdomínio onde o registro deve ser criado
record.valuestringrequired- 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
Toggle tracking
PATCH
https://api.coffeemail.com.br/v1/product/domains/{id}/tracking200Path parameters
idstring≥ 1required- Identificador do domínio
Request body
opensbooleanclicksbooleanhttpsboolean
Response 200
opensbooleanrequired- Insere o pixel de abertura nos envios do domínio
clicksbooleanrequired- Reescreve os links para rastrear cliques
httpsbooleanrequired- Links e pixel rastreados usam https