Kontakte: Listen
Liste löschen
Löschen Sie eine Liste. Sie verschwindet sofort; ihre Mitglieder werden im Hintergrund entfernt. Die Kontakte selbst bleiben erhalten.
https://g.sendcorex.com/v1/contactscommand: delete_listErfordert den Scope contact:delete auf Ihrem API Key.
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_idstringerforderlichDie 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
deletedtrue. Die Liste erscheint nicht mehr in List Lists oder Get List.purgingtrue, 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.
- 401
INVALID_API_KEYDer API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.
- 429
RATE_LIMITEDMehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.
- CMD
MISSING_SCOPEDem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.
- CMD
INVALID_ARGSEin Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …
- CMD
NOT_FOUNDDer Kontakt, die Liste, das Feld oder das Segment existiert nicht.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.