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.

POSThttps://g.sendcorex.com/v1/contactscommand: define_field
i

Erfordert den Scope contact:create auf Ihrem API Key.

i

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

  • keystringerforderlich

    a-z, 0-9 und _, beginnend mit einem Buchstaben, bis zu 40 Zeichen.

    z. B. "plan"

  • typestringerforderlich

    text, number, date, bool, enum oder multi_enum.

    z. B. "enum"

  • namestringoptional

    Anzeigename. Standard: der Schlüssel.

    z. B. "Plan"

  • optionsstring[]optional

    Pflicht für enum und multi_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

  • text

    Bis zu 2.000 Zeichen. Filtern nach Gleichheit (ohne Groß-/Kleinschreibung und Akzente), contains oder exists.

  • number

    Ganzzahlen oder Dezimalzahlen, auch negativ. "1234,5" wird als 1234.5 gelesen. Bereiche und Sortierung.

  • date

    YYYY-MM-DD oder ISO. Bereiche und Sortierung.

  • bool

    true oder false. "yes", "sim" und "1" werden als wahr gelesen.

  • enum

    Eine der options. "PRO" wird als "pro" gespeichert. Ein Wert außerhalb der Optionen lässt den Eintrag fehlschlagen.

  • multi_enum

    Beliebig 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"
      }
    }
  ]
}
i

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.

  • 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. Die anderen Befehle im Request laufen trotzdem.

  • CMDINVALID_ARGS

    Ein Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …

  • CMDTYPE_LOCKED

    define_field hat versucht, den Typ eines bestehenden Felds zu ändern. Löschen Sie es und legen Sie es neu an.

  • CMDLIMIT_REACHED

    Das Konto hat bereits 100 benutzerdefinierte Felder.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.