Kontakte: Segmente

Segmente auflisten

Alle gespeicherten Segmente des Kontos, mit where und sort.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

Dieser Endpoint hat keine Argumente.

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "list_segments"
      }
    ]
  },
  { 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": "list_segments",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "segments": [
          {
            "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

  • segments[].segment_id

    Die von Run Segment verwendete ID.

  • segments[].name

    Anzeigename.

  • segments[].where / sort

    Die gespeicherte Abfrage, im selben Format wie Query Contacts.

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.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.