Kontakte: Benutzerdefinierte Felder
Feld definieren
Legen Sie ein benutzerdefiniertes Feld an oder benennen Sie es um und ändern Sie seine Optionen. Jedes Feld wird einzeln indexiert, Sie können also sofort danach filtern und sortieren.
https://g.sendcorex.com/v1/contactscommand: define_fieldErfordert den Scope contact:create auf Ihrem API Key.
Ein erneuter Aufruf mit gleichem key und type aktualisiert Name und Optionen. Der Typ ändert sich nie: Ein Versuch schlägt mit TYPE_LOCKED fehl. Um ihn zu ändern, löschen Sie das Feld und legen es neu an.
Argumente
keystringerforderlicha-z,0-9und_, beginnend mit einem Buchstaben, bis zu 40 Zeichen.z. B.
"plan"typestringerforderlichtext,number,date,bool,enumodermulti_enum.z. B.
"enum"namestringoptionalAnzeigename. Standard: der Schlüssel.
z. B.
"Plan"optionsstring[]optionalPflicht für
enumundmulti_enum: die erlaubten Werte.z. B.
["free", "pro", "business"]
Schnellstart
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "define_field",
args: {
key: "plan",
name: "Plan",
type: "enum",
options: [
"free",
"pro",
"business"
]
}
}
]
},
{ 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": "define_field",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
],
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-01T10:00:00.000Z"
}
}
]
}Antwortfelder
(field)Das Feld wie gespeichert:
key,name,type,options,created_at,updated_at.
Typen
textBis zu 2.000 Zeichen. Filtern nach Gleichheit (ohne Groß-/Kleinschreibung und Akzente),
containsoderexists.numberGanzzahlen oder Dezimalzahlen, auch negativ.
"1234,5"wird als 1234.5 gelesen. Bereiche und Sortierung.dateYYYY-MM-DDoder ISO. Bereiche und Sortierung.booltrueoderfalse."yes","sim"und"1"werden als wahr gelesen.enumEine der
options."PRO"wird als"pro"gespeichert. Ein Wert außerhalb der Optionen lässt den Eintrag fehlschlagen.multi_enumBeliebig viele
options, als Liste oder als"tech, golf". Kann nicht zum Sortieren verwendet werden.
Alle Felder auf einmal anlegen
Request-Body
{
"commands": [
{
"command": "define_field",
"args": {
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
]
}
},
{
"command": "define_field",
"args": {
"key": "age",
"name": "Age",
"type": "number"
}
},
{
"command": "define_field",
"args": {
"key": "city",
"name": "City",
"type": "text"
}
},
{
"command": "define_field",
"args": {
"key": "birthday",
"name": "Birthday",
"type": "date"
}
},
{
"command": "define_field",
"args": {
"key": "interests",
"name": "Interests",
"type": "multi_enum",
"options": [
"golf",
"tech",
"travel"
]
}
},
{
"command": "define_field",
"args": {
"key": "vip",
"name": "VIP",
"type": "bool"
}
}
]
}Ein Konto kann bis zu 100 Felder haben. Darüber hinaus schlägt define_field mit LIMIT_REACHED fehl.
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. Die anderen Befehle im Request laufen trotzdem.
- CMD
INVALID_ARGSEin Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …
- CMD
TYPE_LOCKEDdefine_field hat versucht, den Typ eines bestehenden Felds zu ändern. Löschen Sie es und legen Sie es neu an.
- CMD
LIMIT_REACHEDDas Konto hat bereits 100 benutzerdefinierte Felder.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.