Kontakte: Segmente

Segment speichern

Speichern Sie eine Abfrage unter einem Namen, damit Ihre App und das Dashboard sie später ausführen können. Die Kontakte werden nicht kopiert: Das Segment wird bei jeder Ausführung neu ausgewertet.

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

Erfordert den Scope contact:create auf Ihrem API Key.

i

Das where wird beim Speichern validiert: Ein unbekannter Schlüssel oder ein unbekanntes Feld schlägt sofort mit INVALID_ARGS fehl, nicht erst bei der nächsten Ausführung.

Argumente

  • segment_idstringoptional

    Ihre eigene ID. Wird erzeugt, wenn sie fehlt. Speichern mit einer bestehenden ID ersetzt dieses Segment.

    z. B. "engaged-vips"

  • namestringoptional

    Anzeigename.

    z. B. "Engaged VIPs"

  • whereobjecterforderlich

    Dasselbe where wie Query Contacts.

  • sortstring | objectoptional

    Dasselbe sort wie Query Contacts.

    z. B. "open_rate"

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          segment_id: "engaged-vips",
          name: "Engaged VIPs",
          where: {
            tags: {
              has: "vip"
            },
            last_open_at: {
              within_days: 30
            }
          },
          sort: "open_rate"
        }
      }
    ]
  },
  { 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": "save_segment",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segment_id": "engaged-vips",
        "name": "Engaged VIPs",
        "where": {
          "tags": {
            "has": "vip"
          },
          "last_open_at": {
            "within_days": 30
          }
        },
        "sort": {
          "field": "open_rate"
        },
        "created_at": "2026-10-10T12:00:00.000Z",
        "updated_at": "2026-10-10T12:00:00.000Z"
      }
    }
  ]
}

Antwortfelder

  • (segment)

    Das Segment wie gespeichert.

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 …

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.