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.
https://g.sendcorex.com/v1/domainMesmo envelope de Contacts, Logs e Bounces & Complaints. As páginas abaixo desta documentam cada comando.
Os erros são informados por comando. Um comando que falha não interrompe os outros, e o status HTTP continua 200.
Domínios são identificados pelo nome (acme.com), nunca por um id interno.
Parâmetros do corpo
commandsobject[]obrigatório1 a 10 comandos, executados em ordem. O corpo inteiro pode ter até 1 MB.
commands[].commandstringobrigatóriolist_domains,get_domain,add_domain,delete_domain,update_domain_description,list_free_domains,start_dkim_upgrade,cancel_dkim_upgrade,send_dns_instructionsourequest_domain_remediation.commands[].argsobjectopcionalOs argumentos do comando. Qualquer valor pode ser um
$refpara o resultado de um comando anterior.commands[].idstringopcionalSeu 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
typeSempre
SUCCESSquando o request em si foi aceito.results[].commandO comando que gerou este resultado.
results[].idO
idque você enviou, ou o índice do comando.results[].typeSUCCESSouERROR.results[].took_msTempo que o comando levou dentro do servidor. Comandos que verificam DNS demoram mais.
results[].dataA saída do comando. Só presente quando
typeéSUCCESS.results[].code / messageO 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.
AuthorizationEnvie
Authorization: <api key>ouAuthorization: Bearer <api key>.domain:readlist_domains,get_domain,list_free_domainsesend_dns_instructions.domain:createadd_domain,start_dkim_upgrade,cancel_dkim_upgrade,update_domain_descriptionerequest_domain_remediation.domain:deletedelete_domain. Dê só a chaves que realmente precisam: excluir um domínio também exclui seus senders.Tokens de mailboxO token do webmail não funciona aqui. Ele é rejeitado com
WRONG_CREDENTIAL_TYPE.IPs permitidosSe 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 / segundoPor IP + API key. Acima disso, HTTP 429 com um header
Retry-After.15 simultâneosNo máximo 15 requests sendo processados ao mesmo tempo, por IP + API key.
Por comando, por contaadd_domain10/min ·get_domain60/min ·delete_domain30/min ·start_dkim_upgradeecancel_dkim_upgrade10/min ·update_domain_description20/min ·send_dns_instructionserequest_domain_remediation5/min. Acima disso, o comando respondeRATE_LIMITED.Sem cacheToda 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.
- 400
INVALID_JSONO corpo não é {"commands":[...]} ou tem mais de 1 MB.
- 400
INVALID_ARGSO request não tem comandos ou tem mais de 10.
- 401
MISSING_AUTH_HEADERNenhum header Authorization foi enviado.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 401
API_KEY_EXPIREDA API key passou da data de expiração definida no dashboard.
- 401
WRONG_CREDENTIAL_TYPEFoi enviado um token de mailbox. A Domains API precisa de uma API key do dashboard.
- 403
IP_NOT_ALLOWEDO request veio de um IP que não está nos IPs permitidos da chave.
- 403
ACCOUNT_BLOCKEDA conta está bloqueada.
- 403
MISSING_SCOPEA chave não tem nenhum scope `domain:*`, então nenhum comando pode rodar.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- 503
AUTH_UNAVAILABLEA autenticação está temporariamente indisponível. Tente de novo.
- CMD
UNKNOWN_COMMANDO nome do comando não existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.