Domaines : routes

Run Commands

Le point d'entrée unique pour les domaines d'envoi. Envoyez de 1 à 10 commandes dans une requête et recevez un résultat par commande.

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

Même enveloppe que Contacts, Logs et Bounces & Complaints. Les pages suivantes documentent chaque commande.

i

Les erreurs sont signalées par commande. Une commande qui échoue n'arrête pas les autres, et le statut HTTP reste 200.

i

Les domaines sont identifiés par leur nom (acme.com), jamais par un id interne.

Paramètres du corps

  • commandsobject[]obligatoire

    De 1 à 10 commandes, exécutées dans l'ordre. Le corps entier peut faire jusqu'à 1 Mo.

  • commands[].commandstringobligatoire

    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[].argsobjectfacultatif

    Les arguments de la commande. Toute valeur peut être un $ref vers le résultat d'une commande précédente.

  • commands[].idstringfacultatif

    Votre propre identifiant pour le résultat. Par défaut, l'index ("0", "1"…). Obligatoire si vous voulez utiliser $ref.

Démarrage rapide

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);
}

Réponse

{
  "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"
        ]
      }
    }
  ]
}

Champs de la réponse

  • type

    Toujours SUCCESS quand la requête elle-même a été acceptée.

  • results[].command

    La commande qui a produit ce résultat.

  • results[].id

    L'id que vous avez envoyé, ou l'index de la commande.

  • results[].type

    SUCCESS ou ERROR.

  • results[].took_ms

    Temps passé par la commande dans le serveur. Les commandes qui vérifient le DNS prennent plus de temps.

  • results[].data

    La sortie de la commande. Présente uniquement quand type vaut SUCCESS.

  • results[].code / message

    L'erreur. Présente uniquement quand type vaut ERROR.

Authentification

Utilisez l'API key que vous créez dans le dashboard, sous Developers → API Keys, avec les scopes requis par les commandes.

  • Authorization

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

  • domain:read

    list_domains, get_domain, list_free_domains et send_dns_instructions.

  • domain:create

    add_domain, start_dkim_upgrade, cancel_dkim_upgrade, update_domain_description et request_domain_remediation.

  • domain:delete

    delete_domain. Ne l'accordez qu'aux clés qui en ont vraiment besoin : supprimer un domaine supprime aussi ses senders.

  • Tokens de boîte mail

    Le token du webmail ne fonctionne pas ici. Il est refusé avec WRONG_CREDENTIAL_TYPE.

  • IP autorisées

    Si la clé a une liste d'IP autorisées, les requêtes venant d'autres IP reçoivent 403 IP_NOT_ALLOWED.

Enchaîner avec $ref

Ajoutez un domaine et relisez-le en une requête : la seconde commande prend le domaine dans le premier résultat.

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

Deux limites. La première s'applique à toute la route, la seconde à certaines commandes.

  • 15 requêtes / seconde

    Par IP + API key. Au-delà, HTTP 429 avec un header Retry-After.

  • 15 simultanées

    Au maximum 15 requêtes traitées en même temps, par IP + API key.

  • Par commande, par compte

    add_domain 10/min · get_domain 60/min · delete_domain 30/min · start_dkim_upgrade et cancel_dkim_upgrade 10/min · update_domain_description 20/min · send_dns_instructions et request_domain_remediation 5/min. Au-delà, la commande répond RATE_LIMITED.

  • Pas de cache

    Chaque appel lit la base de données (et le DNS, pour get_domain). Ce que vous obtenez est toujours à jour.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 400INVALID_JSON

    Le corps n'est pas {"commands":[...]} ou dépasse 1 Mo.

  • 400INVALID_ARGS

    La requête ne contient aucune commande ou plus de 10.

  • 401MISSING_AUTH_HEADER

    Aucun header Authorization n'a été envoyé.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.

  • 401API_KEY_EXPIRED

    L'API key a dépassé la date d'expiration définie dans le dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Un token de boîte mail a été envoyé. La Domains API nécessite une API key du dashboard.

  • 403IP_NOT_ALLOWED

    La requête provient d'une IP qui ne figure pas parmi les IP autorisées de la clé.

  • 403ACCOUNT_BLOCKED

    Le compte est bloqué.

  • 403MISSING_SCOPE

    La clé n'a aucun scope `domain:*`, donc aucune commande ne peut s'exécuter.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • 503AUTH_UNAVAILABLE

    L'authentification est temporairement indisponible. Réessayez.

  • CMDUNKNOWN_COMMAND

    Le nom de la commande n'existe pas.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.