Saltar al contenido principal
Referencia de la API

Dominios

Registrar dominios, revisar DNS, DKIM, seguimiento y calentamiento.

Listar dominios

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

Respuesta 200

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

Agregar dominio

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

Cuerpo de la solicitud

namestring≥ 3≤ 253obligatorio
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

Respuesta 201

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

Obtener dominio

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

idstring (uuid)obligatorio
Identificador único do domínio
namestringobligatorio
Nome do domínio cadastrado para envio de emails
status"pending" | "verified" | "failed"obligatorio
Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"obligatorio
Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
sendingIdentityobjectobligatorio
Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"obligatorio
Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"obligatorio
Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)obligatorio
Data e hora da última sincronização com o provedor de envio
dkimSelectorstringobligatorio
Seletor usado no registro DKIM do domínio
dkimPublicKeystringobligatorio
Chave pública DKIM gerada para o domínio
verifiedAtstring (date-time)obligatorio
Data e hora em que o domínio foi verificado
lastCheckAtstring (date-time)obligatorio
Data e hora da última verificação de DNS realizada
createdAtstring (date-time)obligatorio
Data e hora em que o domínio foi cadastrado
dnsRecordsToPublisharray<object>obligatorio
Registros DNS pendentes que o cliente precisa publicar
dkimRotationobjectobligatorio
Rotação de DKIM em andamento, ou null quando não há rotação pendente
dkimRotation.domainIdstring (uuid)obligatorio
Identificador único do domínio
dkimRotation.selectorstringobligatorio
Seletor DKIM pendente, que passa a valer após a propagação do DNS
dkimRotation.startedAtstring (date-time)obligatorio
Data e hora em que a rotação foi iniciada
dkimRotation.recordobjectobligatorio
Registro TXT que precisa ser publicado para concluir a rotação
returnPathobjectobligatorio
Return-path próprio (bounces.<domínio>), ou null quando a plataforma não oferece return-path
returnPath.hoststringobligatorio
Host do domínio do cliente que precisa apontar para a plataforma
returnPath.targetstringobligatorio
Host da plataforma para onde o CNAME deve apontar
returnPath.verifiedbooleanobligatorio
Indica se o CNAME foi encontrado apontando para o alvo
returnPath.verifiedAtstring (date-time)obligatorio
Data e hora em que o CNAME foi confirmado
returnPath.recordobjectobligatorio
Registro CNAME a publicar
trackingDomainobjectobligatorio
Host de tracking próprio do domínio, ou null quando não há host cadastrado ou o recurso está desligado
trackingDomain.hoststringobligatorio
Host do domínio do cliente que precisa apontar para a plataforma
trackingDomain.targetstringobligatorio
Host da plataforma para onde o CNAME deve apontar
trackingDomain.verifiedbooleanobligatorio
Indica se o CNAME foi encontrado apontando para o alvo
trackingDomain.verifiedAtstring (date-time)obligatorio
Data e hora em que o CNAME foi confirmado
trackingDomain.recordobjectobligatorio
Registro CNAME a publicar
trackingDomainsAvailablebooleanobligatorio
Indica se a plataforma permite cadastrar um host de tracking próprio
warningsarray<object>obligatorio
Avisos da última verificação de DNS; não mudam o status do domínio
checksobjectobligatorio
Status de cada registro DNS do domínio
checks.spfobjectobligatorio
checks.dkimobjectobligatorio
checks.dmarcobjectobligatorio
checks.ownershipobjectobligatorio
checks.returnPathobjectobligatorio
checks.trackingobjectobligatorio
trackingobjectobligatorio
Opções de rastreamento do domínio
tracking.opensbooleanobligatorio
Insere o pixel de abertura nos envios do domínio
tracking.clicksbooleanobligatorio
Reescreve os links para rastrear cliques
tracking.httpsbooleanobligatorio
Links e pixel rastreados usam https

Eliminar dominio

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Cuerpo de la solicitud

method"totp" | "password" | "email_token"obligatorio
Método usado para reautenticar antes de excluir o domínio
credentialstring≥ 1≤ 512obligatorio
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 de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

idstring (uuid)obligatorio
Identificador único do domínio
namestringobligatorio
Nome do domínio verificado
status"pending" | "verified" | "failed"obligatorio
Situação atual da verificação do domínio
statusReason"dns_records_missing" | "provider_pending" | "provider_failed"obligatorio
Motivo do status atual: registros DNS ausentes, provedor de envio ainda confirmando a assinatura ou provedor rejeitou a configuração
verifiedAtstring (date-time)obligatorio
Data e hora em que o domínio foi verificado com sucesso
checksobjectobligatorio
Resultados individuais de cada checagem de DNS realizada
checks.spfobjectobligatorio
Resultado da checagem do registro SPF
checks.dkimobjectobligatorio
Resultado da checagem do registro DKIM
checks.dmarcobjectobligatorio
Resultado da checagem do registro DMARC
checks.ownershipobjectobligatorio
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">obligatorio
Checagens obrigatórias para considerar o domínio verificado
warningsarray<object>obligatorio
Avisos da última verificação de DNS; não mudam o status do domínio
sendingIdentityobjectobligatorio
Situação do domínio no provedor de envio
sendingIdentity.provider"aws_ses" | "none"obligatorio
Provedor de envio responsável pela assinatura DKIM
sendingIdentity.state"not_provisioned" | "pending" | "ready" | "failed"obligatorio
Situação da identidade do domínio no provedor de envio
sendingIdentity.lastSyncedAtstring (date-time)obligatorio
Data e hora da última sincronização com o provedor de envio

Revisar salud del dominio

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

domainIdstring (uuid)obligatorio
Identificador único do domínio
domainstringobligatorio
Nome do domínio verificado
status"healthy" | "warning" | "critical"obligatorio
Resultado geral da checagem de saúde do domínio
spfobjectobligatorio
Resultado da checagem do registro SPF
spf.okbooleanobligatorio
Indica se o registro SPF está correto
spf.expectedstringobligatorio
Valor esperado do registro SPF
spf.gotstringobligatorio
Valor do registro SPF encontrado no DNS
dkimobjectobligatorio
Resultado da checagem do registro DKIM
dkim.okbooleanobligatorio
Indica se o registro DKIM está correto
dkim.expectedstringobligatorio
Valor esperado do registro DKIM
dkim.gotstringobligatorio
Valor do registro DKIM encontrado no DNS
dmarcobjectobligatorio
Resultado da checagem do registro DMARC
dmarc.okbooleanobligatorio
Indica se o registro DMARC está correto
dmarc.expectedstringobligatorio
Valor esperado do registro DMARC
dmarc.gotstringobligatorio
Valor do registro DMARC encontrado no DNS
checkedAtstring (date-time)obligatorio
Data e hora em que a checagem foi realizada

Plan de calentamiento

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

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

Rotar DKIM

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

domainIdstring (uuid)obligatorio
Identificador único do domínio
selectorstringobligatorio
Seletor DKIM pendente, que passa a valer após a propagação do DNS
startedAtstring (date-time)obligatorio
Data e hora em que a rotação foi iniciada
recordobjectobligatorio
Registro TXT que precisa ser publicado para concluir a rotação
record.type"TXT" | "CNAME"obligatorio
Tipo do registro DNS a ser publicado
record.hoststringobligatorio
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobligatorio
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 dominio de seguimiento

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Cuerpo de la solicitud

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

Respuesta 200

hoststringobligatorio
Host do domínio do cliente que precisa apontar para a plataforma
targetstringobligatorio
Host da plataforma para onde o CNAME deve apontar
verifiedbooleanobligatorio
Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)obligatorio
Data e hora em que o CNAME foi confirmado
recordobjectobligatorio
Registro CNAME a publicar
record.type"TXT" | "CNAME"obligatorio
Tipo do registro DNS a ser publicado
record.hoststringobligatorio
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobligatorio
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

Eliminar dominio de seguimiento

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Respuesta 200

hoststringobligatorio
Host do domínio do cliente que precisa apontar para a plataforma
targetstringobligatorio
Host da plataforma para onde o CNAME deve apontar
verifiedbooleanobligatorio
Indica se o CNAME foi encontrado apontando para o alvo
verifiedAtstring (date-time)obligatorio
Data e hora em que o CNAME foi confirmado
recordobjectobligatorio
Registro CNAME a publicar
record.type"TXT" | "CNAME"obligatorio
Tipo do registro DNS a ser publicado
record.hoststringobligatorio
Nome do host/subdomínio onde o registro deve ser criado
record.valuestringobligatorio
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

Activar o desactivar seguimiento

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador do domínio

Cuerpo de la solicitud

opensboolean
clicksboolean
httpsboolean

Respuesta 200

opensbooleanobligatorio
Insere o pixel de abertura nos envios do domínio
clicksbooleanobligatorio
Reescreve os links para rastrear cliques
httpsbooleanobligatorio
Links e pixel rastreados usam https