Domínios: rotas

Run Commands

O ponto de entrada único para domínios de envio. Envie de 1 a 10 comandos em um request e receba um resultado por comando.

POSThttps://g.sendcorex.com/v1/domain
i

Mesmo envelope de Contacts, Logs e Bounces & Complaints. As páginas abaixo desta documentam cada comando.

i

Os erros são informados por comando. Um comando que falha não interrompe os outros, e o status HTTP continua 200.

i

Domínios são identificados pelo nome (acme.com), nunca por um id interno.

Parâmetros do corpo

  • commandsobject[]obrigatório

    1 a 10 comandos, executados em ordem. O corpo inteiro pode ter até 1 MB.

  • commands[].commandstringobrigatório

    list_domains, get_domain, add_domain, delete_domain, update_domain_description, list_free_domains, start_dkim_upgrade, cancel_dkim_upgrade, send_dns_instructions ou request_domain_remediation.

  • commands[].argsobjectopcional

    Os argumentos do comando. Qualquer valor pode ser um $ref para o resultado de um comando anterior.

  • commands[].idstringopcional

    Seu próprio identificador para o resultado. Padrão: o índice ("0", "1"…). Obrigatório se você quiser usar $ref.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/domain',
  {
    commands: [
      {
        command: "list_domains",
        id: "mine"
      },
      {
        command: "list_free_domains",
        id: "free"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

for (const result of response.data.results) {
  if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
  else console.log(result.id, result.data);
}

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "list_domains",
      "id": "mine",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "domains": [
          {
            "domain": "acme.com",
            "validated": true,
            "has_mx": true,
            "has_spf": true,
            "has_dkim": true,
            "has_dmarc": true,
            "has_return_path": true,
            "description": "Transactional (app emails)",
            "dkim_key_size": 2048,
            "dkim_deprecated": false,
            "dkim_upgrade_pending": false,
            "created_at": "2026-09-02T14:21:07.118Z",
            "updated_at": "2026-10-21T02:40:51.902Z"
          }
        ]
      }
    },
    {
      "command": "list_free_domains",
      "id": "free",
      "type": "SUCCESS",
      "took_ms": 0,
      "data": {
        "domains": [
          "corexsend.com",
          "inboxtaken.com",
          "outsending.com",
          "shieldhaus.uk",
          "shieldhaus.info",
          "mailverifypro.info",
          "mailverifypro.online",
          "mailverifypro.store",
          "mailverifypro.org"
        ]
      }
    }
  ]
}

Campos da resposta

  • type

    Sempre SUCCESS quando o request em si foi aceito.

  • results[].command

    O comando que gerou este resultado.

  • results[].id

    O id que você enviou, ou o índice do comando.

  • results[].type

    SUCCESS ou ERROR.

  • results[].took_ms

    Tempo que o comando levou dentro do servidor. Comandos que verificam DNS demoram mais.

  • results[].data

    A saída do comando. Só presente quando type é SUCCESS.

  • results[].code / message

    O erro. Só presente quando type é ERROR.

Autenticação

Use a API key que você cria no dashboard, em Developers → API Keys, com os scopes de que os comandos precisam.

  • Authorization

    Envie Authorization: <api key> ou Authorization: Bearer <api key>.

  • domain:read

    list_domains, get_domain, list_free_domains e send_dns_instructions.

  • domain:create

    add_domain, start_dkim_upgrade, cancel_dkim_upgrade, update_domain_description e request_domain_remediation.

  • domain:delete

    delete_domain. Dê só a chaves que realmente precisam: excluir um domínio também exclui seus senders.

  • Tokens de mailbox

    O token do webmail não funciona aqui. Ele é rejeitado com WRONG_CREDENTIAL_TYPE.

  • IPs permitidos

    Se a chave tiver uma lista de IPs permitidos, requests de outros IPs recebem 403 IP_NOT_ALLOWED.

Encadeando com $ref

Adicione um domínio e leia-o de volta em um request: o segundo comando pega o domínio do primeiro resultado.

add_domain → get_domain

{
  "commands": [
    {
      "command": "add_domain",
      "id": "new",
      "args": {
        "domain": "acme.com"
      }
    },
    {
      "command": "get_domain",
      "args": {
        "domain": {
          "$ref": "new",
          "path": "domain"
        }
      }
    }
  ]
}

Rate limits

Dois limites. O primeiro vale para a rota inteira, o segundo para alguns comandos.

  • 15 requests / segundo

    Por IP + API key. Acima disso, HTTP 429 com um header Retry-After.

  • 15 simultâneos

    No máximo 15 requests sendo processados ao mesmo tempo, por IP + API key.

  • Por comando, por conta

    add_domain 10/min · get_domain 60/min · delete_domain 30/min · start_dkim_upgrade e cancel_dkim_upgrade 10/min · update_domain_description 20/min · send_dns_instructions e request_domain_remediation 5/min. Acima disso, o comando responde RATE_LIMITED.

  • Sem cache

    Toda chamada lê o banco de dados (e o DNS, em get_domain). O que você recebe é sempre atual.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 400INVALID_JSON

    O corpo não é {"commands":[...]} ou tem mais de 1 MB.

  • 400INVALID_ARGS

    O request não tem comandos ou tem mais de 10.

  • 401MISSING_AUTH_HEADER

    Nenhum header Authorization foi enviado.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 401API_KEY_EXPIRED

    A API key passou da data de expiração definida no dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Foi enviado um token de mailbox. A Domains API precisa de uma API key do dashboard.

  • 403IP_NOT_ALLOWED

    O request veio de um IP que não está nos IPs permitidos da chave.

  • 403ACCOUNT_BLOCKED

    A conta está bloqueada.

  • 403MISSING_SCOPE

    A chave não tem nenhum scope `domain:*`, então nenhum comando pode rodar.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • 503AUTH_UNAVAILABLE

    A autenticação está temporariamente indisponível. Tente de novo.

  • CMDUNKNOWN_COMMAND

    O nome do comando não existe.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.