Kontakte: Listen

Liste erstellen

Legen Sie eine Liste an. Wählen Sie eine eigene ID, damit Ihr Code darauf verweisen kann, oder lassen Sie den Server eine erzeugen.

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

Erfordert den Scope contact:create auf Ihrem API Key.

i

Eine Liste gruppiert Kontakte für den Versand. Der Kontakt selbst gehört zum Konto: Das Hinzufügen zu einer Liste kopiert ihn nicht.

Argumente

  • list_idstringoptional

    Ihre eigene ID: a-z, 0-9, _ und -, bis zu 40 Zeichen. Wird erzeugt, wenn sie fehlt. Eine bereits existierende ID schlägt mit ALREADY_EXISTS fehl.

    z. B. "customers"

  • namestringoptional

    Anzeigename.

    z. B. "Customers"

  • descriptionstringoptional

    Freitext, der mit der Liste angezeigt wird.

  • sourcestringoptional

    Woher die Kontakte stammen, zu Ihrer Information.

    z. B. "checkout"

  • customobjectoptional

    Ihre eigenen Daten, bis zu 50 Schlüssel.

    z. B. { "origin": "checkout", "year": 2026 }

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "create_list",
        args: {
          list_id: "customers",
          name: "Customers",
          description: "Everyone who bought at least once",
          source: "checkout",
          custom: {
            origin: "checkout",
            year: 2026
          }
        }
      }
    ]
  },
  { 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": "create_list",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "list_id": "customers",
        "name": "Customers",
        "description": "Everyone who bought at least once",
        "source": "checkout",
        "status": "ready",
        "custom": {
          "origin": "checkout",
          "year": 2026
        },
        "created_at": "2026-10-01T10:00:00.000Z",
        "updated_at": "2026-10-12T15:22:41.000Z",
        "stats": {
          "total": 0,
          "ok": 0,
          "opened": 0,
          "clicked": 0
        }
      }
    }
  ]
}

Antwortfelder

  • list_id

    Die gesendete oder die erzeugte ID.

  • status

    ready.

  • stats

    Zähler, bei einer neuen Liste alle 0.

Als Nächstes: befüllen

Senden Sie list_id mit Upsert Contacts, um direkt in die Liste zu importieren, oder verwenden Sie Add To Lists für bereits vorhandene Kontakte.

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 …

  • CMDALREADY_EXISTS

    create_list wurde mit einer list_id aufgerufen, die bereits existiert.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.