Domínios e DKIM

Antes de enviar e-mail com um endereço @seudominio.com, o domínio precisa ser registrado e verificado (SPF, DKIM, DMARC).

Criar um domínio

POST /v1/domains

{ "name": "meudominio.com" }

Resposta — 201 Created:

{
  "domain": {
    "id": "b3f1...-uuid",
    "name": "meudominio.com",
    "status": "pending",
    "spf_verified": false,
    "dkim_verified": false,
    "dmarc_verified": false,
    "return_path_subdomain": "bounce",
    "created_at": "2026-08-29T12:00:00Z"
  },
  "dns_records": [
    { "type": "TXT", "host": "meudominio.com", "value": "v=spf1 include:...  ~all" },
    { "type": "CNAME", "host": "viapost._domainkey.meudominio.com", "value": "..." },
    { "type": "TXT", "host": "_dmarc.meudominio.com", "value": "v=DMARC1; p=none;" }
  ]
}

Configure os registros DNS retornados em dns_records no provedor de DNS do domínio.

Listar domínios

GET /v1/domains

Retorna até 50 domínios do tenant: {"domains": [ {domínio}, ... ]}.

Consultar um domínio

GET /v1/domains/{id}

Consultar registros DNS

GET /v1/domains/{id}/dns

200 — {"dns_records": [...]} (mesmo schema retornado na criação).

Verificar um domínio

POST /v1/domains/{id}/verify

Dispara a checagem dos registros DNS. Retorna o domínio atualizado — status passa a verified se todos os registros necessários forem encontrados, ou permanece pending com os campos spf_verified/dkim_verified/dmarc_verified refletindo o que já foi confirmado.

Rotacionar a chave DKIM

POST /v1/domains/{id}/dkim/rotate

Gera um novo par de chaves DKIM para o domínio:

{ "selector": "viapost2", "public_key": "...", "status": "pending" }

Atualize o registro CNAME/TXT do novo selector no DNS antes que o antigo expire.

Remover um domínio

DELETE /v1/domains/{id}

204 No Content.

Erros comuns

401 sem API Key, 404 domínio não encontrado ou pertencente a outro tenant, 400 id que não é um UUID válido.