Nutzer:innen-Beziehung löschen

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

Wichtig

Data Objects befindet sich derzeit im Early Access. Ihr Workspace muss aktiviert sein, bevor die Data-Objects-API-Schlüsselberechtigungen 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.user_relationships.delete.

Rate-Limit

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

Anfrageparameter

Die folgende Tabelle listet und beschreibt die JSON-Anfragebody-Parameter für den Endpunkt /data_objects/objects/{type_name}/{external_id}/users.

Hinweis

Dieser DELETE-Endpunkt erwartet einen JSON-Anfragebody. Stellen Sie sicher, dass Ihr HTTP-Client Anfragebodys bei DELETE-Aufrufen sendet.

Beispielanfrage

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

Beispiel-Anfrage-Payload

1
2
3
4

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

Beispiel-cURL-Anfrage

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

1
2
3
4
5
6
7

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 Antwortbody zurückgeben.

1

{ "deleted": true }

Antwortparameter

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

Fehler

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