Zum Inhalt springen

Diese Seite wurde automatisch übersetzt und kann Ungenauigkeiten enthalten. Um einen Übersetzungsfehler zu melden, nutzen Sie das Feedback unten im Inhaltsverzeichnis rechts auf der Seite.

Datenobjekt löschen

delete

/data_objects/objects/{type_name}/{object_id}

Verwenden Sie diesen Endpunkt, um ein Datenobjekt zu löschen.

Wichtig

Datenobjekte sind allgemein verfügbar, aber Ihr Workspace muss für Accounts freigeschaltet sein, bevor Sie diesen Endpunkt verwenden können. Um die Freischaltung anzufordern, gehen Sie zu Dateneinstellungen > Accounts und füllen Sie den Fragebogen aus. Weitere Informationen finden Sie unter Accounts aktivieren.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung data_objects.delete.

Rate-Limit

Dieser Endpunkt gehört zum Schreib-Bucket für Datenobjekte mit einem Standardlimit von 1000 Anfragen pro Minute.

Pfadparameter

Die folgende Tabelle listet und beschreibt die Pfadparameter für den Endpunkt /data_objects/objects/{type_name}/{object_id}.

Parameter	Erforderlich	Datentyp	Beschreibung
`type_name`	Erforderlich	String	Maschinenname des Datenobjekttyps
`object_id`	Erforderlich	String	Objektbezeichner

Beispielanfrage

Dieser Abschnitt enthält ein Beispiel für die Pfadparameter-Payload und eine cURL-Beispielanfrage.

Beispiel-Payload der Anfrage

Verwenden Sie dieses JSON-Objekt als Referenz für die Pfadparameter in dieser Anfrage.

{
  "type_name": "account",
  "object_id": "acct-123"
}

cURL-Beispielanfrage

Dieses Beispiel löscht den Kontodatensatz acct-123.

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Antwort

Dieser Abschnitt enthält ein Beispiel für eine erfolgreiche Antwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 200 kann den folgenden Antwort-Body zurückgeben.

{ "deleted": true }

Das Löschen erfolgt synchron. Wenn Sie ein Objekt löschen, werden zugehörige Objekte nicht mitgelöscht.

Antwortparameter

Die folgende Tabelle listet und beschreibt die Felder einer erfolgreichen Antwort.

Parameter	Erforderlich	Datentyp	Beschreibung
`deleted`	Erforderlich	Boolean	Gibt an, ob das Löschen des Objekts erfolgreich war

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt auf und beschreibt, wie Sie sie beheben können.

Status	Ursache	Lösung
`404`	Typ nicht gefunden oder Objekt nicht gefunden	Vergewissern Sie sich, dass sowohl `type_name` als auch `object_id` im Workspace vorhanden sind.
`401`	Fehlender oder ungültiger REST-API-Schlüssel	Überprüfen Sie, ob der `Authorization`-Header `Bearer YOUR_REST_API_KEY` verwendet und ob der Schlüssel aktiv ist.
`403`	API-Schlüssel hat keine Berechtigung oder die Anfrage wird durch die Allowlist blockiert	Vergewissern Sie sich, dass der Schlüssel die Berechtigung `data_objects.delete` hat und dass Ihre Quell-IP auf der Allowlist des Schlüssels steht, falls diese konfiguriert ist.
`429`	Rate-Limit überschritten	Versuchen Sie es nach `X-RateLimit-Reset` erneut und reduzieren Sie die Anfragehäufigkeit.

New Stuff!