Domains: Domains
Domainbeschreibung aktualisieren
Legt Ihre eigene Notiz zu einer Domain fest, etwa wofür sie verwendet wird. Nur Sie sehen sie.
https://g.sendcorex.com/v1/domaincommand: update_domain_descriptionErfordert den Scope domain:create auf Ihrem API Key.
Bis zu 20 Aufrufe pro Minute und Konto. Darüber antwortet der Befehl mit RATE_LIMITED.
Argumente
domainstringerforderlichDer Domainname.
z. B.
"acme.com"descriptionstring | nullerforderlichBis zu 255 Zeichen, kein HTML.
nulloder""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
domainDie Domain.
descriptionDie 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.
- 401
INVALID_API_KEYDer API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.
- 429
RATE_LIMITEDMehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.
- CMD
MISSING_SCOPEDem API Key fehlt der Scope, den dieser Befehl braucht.
- CMD
INVALID_ARGSEin Argument ist ungültig: fehlende oder fehlerhafte `domain`, `key_size` ungleich 1024/2048, ungültige `email`, eine Beschreibung über 255 Zeichen …
- CMD
DOMAIN_NOT_FOUNDDie Domain ist nicht in Ihrem Konto.
- CMD
RATE_LIMITEDDieser Befehl wurde in der letzten Minute zu oft von Ihrem Konto aufgerufen. Warten Sie eine Minute.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.