Kontakte: Listen

Liste löschen

Löschen Sie eine Liste. Sie verschwindet sofort; ihre Mitglieder werden im Hintergrund entfernt. Die Kontakte selbst bleiben erhalten.

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

Erfordert den Scope contact:delete auf Ihrem API Key.

i

Nur die Mitgliedschaft wird entfernt. Die Kontakte, ihre Tags, Felder und anderen Listen bleiben. Um auch die Personen zu löschen, fragen Sie sie zuerst ab und verwenden Sie Delete Contacts.

Argumente

  • list_idstringerforderlich

    Die zu löschende Liste.

    z. B. "old-leads"

Schnellstart

import axios from 'axios';

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

Antwortfelder

  • deleted

    true. Die Liste erscheint nicht mehr in List Lists oder Get List.

  • purging

    true, solange die Mitglieder im Hintergrund aus der Liste entfernt werden.

Was im Hintergrund passiert

Große Listen werden in Stapeln bereinigt. Bis das fertig ist, zeigt list_lists mit include_deleting: true die Liste noch mit status: "deleting".

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 …

  • CMDNOT_FOUND

    Der Kontakt, die Liste, das Feld oder das Segment existiert nicht.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.