Datenobjekt löschen

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

Wichtig

Datenobjekte befinden sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die API-Schlüssel-Berechtigungen für Datenobjekte unter Einstellungen > API-Schlüssel angezeigt werden.

Voraussetzungen

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

Rate-Limit

Dieser Endpunkt befindet sich im Schreib-Bucket für Datenobjekte mit einem Standardlimit von 50 Anfragen pro Minute.

Pfadparameter

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

Beispielanfrage

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

Beispiel-Anfragenutzlast

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

1
2
3
4

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

cURL-Beispielanfrage

Dieses Beispiel löscht den Kontodatensatz acct-123.

1
2

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 Antwortkörper zurückgeben.

1

{ "deleted": true }

Das Löschen erfolgt synchron. Das Löschen eines Objekts löscht keine verwandten Objekte.

Antwortparameter

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

Fehler

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