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.

Nutzer:innen-Beziehung löschen

delete

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

Verwenden Sie diesen Endpunkt, um eine Beziehung zwischen Nutzer:in und Objekt zu entfernen.

Wichtig

Data Objects ist 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.user_relationships.delete.

Rate-Limit

Dieser Endpunkt gehört zum Data-Objects-Schreib-Bucket 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}/users.

Parameter	Erforderlich	Datentyp	Beschreibung
`type_name`	Erforderlich	String	Objekttyp
`object_id`	Erforderlich	String	Objektbezeichner

Anfrageparameter

Die folgende Tabelle listet und beschreibt die Parameter im JSON-Anfrage-Body für den Endpunkt /data_objects/objects/{type_name}/{object_id}/users.

Parameter	Erforderlich	Datentyp	Beschreibung
`braze_id`	Erforderlich	String	Braze-Nutzer:innen-ID
`rel_kind`	Erforderlich	String	Beziehungstyp

Hinweis

Dieser DELETE-Endpunkt erwartet einen JSON-Anfrage-Body. Stellen Sie sicher, dass Ihr HTTP-Client bei DELETE-Aufrufen einen Anfrage-Body mitsendet.

Beispielanfrage

Dieser Abschnitt enthält eine Beispiel-JSON-Payload und eine Beispiel-cURL-Anfrage.

Beispiel-Anfrage-Payload

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

Beispiel-cURL-Anfrage

Dieses Beispiel entfernt die account_user-Beziehung zwischen dem/der angegebenen Nutzer:in und acct-123. Das Nutzerprofil und der Account-Datensatz bleiben beide erhalten.

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}'

Antwort

Dieser Abschnitt enthält eine Beispielantwort bei Erfolg und die Antwortfelder.

Beispiel einer erfolgreichen Antwort

Der Statuscode 200 könnte den folgenden Antwort-Body zurückgeben.

{ "deleted": true }

Antwortparameter

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

Parameter	Erforderlich	Datentyp	Beschreibung
`deleted`	Erforderlich	Boolean	Ob das Löschen der Beziehung erfolgreich war

Fehler

Die folgende Tabelle listet häufige Fehler für diesen Endpunkt und deren Behebung auf.

Status	Ursache	Lösung
`400`	Validierungsfehler	Stellen Sie sicher, dass der Anfrage-Body gültige Werte für `braze_id` und `rel_kind` enthält.
`404`	Beziehung oder Objekt nicht gefunden	Stellen Sie sicher, dass das Objekt, der/die Nutzer:in und die Werte des Beziehungsschlüssels alle existieren.
`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	Stellen Sie sicher, dass der Schlüssel die Berechtigung `data_objects.user_relationships.delete` hat und dass Ihre Quell-IP auf der Allowlist des Schlüssels steht, falls konfiguriert.
`429`	Rate-Limit überschritten	Versuchen Sie es nach `X-RateLimit-Reset` erneut und reduzieren Sie die Anfragehäufigkeit.

New Stuff!