Domains: Domains

Domainbeschreibung aktualisieren

Legt Ihre eigene Notiz zu einer Domain fest, etwa wofür sie verwendet wird. Nur Sie sehen sie.

POSThttps://g.sendcorex.com/v1/domaincommand: update_domain_description
i

Erfordert den Scope domain:create auf Ihrem API Key.

i

Bis zu 20 Aufrufe pro Minute und Konto. Darüber antwortet der Befehl mit RATE_LIMITED.

Argumente

  • domainstringerforderlich

    Der Domainname.

    z. B. "acme.com"

  • descriptionstring | nullerforderlich

    Bis zu 255 Zeichen, kein HTML. null oder "" löscht sie.

    z. B. "Transactional (app emails)"

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/domain',
  {
    commands: [
      {
        command: "update_domain_description",
        args: {
          domain: "acme.com",
          description: "Transactional (app emails)"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Antwort

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "update_domain_description",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 4,
      "data": {
        "domain": "acme.com",
        "description": "Transactional (app emails)"
      }
    }
  ]
}

Antwortfelder

  • domain

    Die Domain.

  • description

    Die gespeicherte Beschreibung oder null.

Fehler

Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.

  • 401INVALID_API_KEY

    Der API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.

  • 429RATE_LIMITED

    Mehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.

  • CMDMISSING_SCOPE

    Dem API Key fehlt der Scope, den dieser Befehl braucht.

  • CMDINVALID_ARGS

    Ein Argument ist ungültig: fehlende oder fehlerhafte `domain`, `key_size` ungleich 1024/2048, ungültige `email`, eine Beschreibung über 255 Zeichen …

  • CMDDOMAIN_NOT_FOUND

    Die Domain ist nicht in Ihrem Konto.

  • CMDRATE_LIMITED

    Dieser Befehl wurde in der letzten Minute zu oft von Ihrem Konto aufgerufen. Warten Sie eine Minute.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.