Nutzer:innen-Beziehung ersetzen

Verwenden Sie diesen Endpunkt, um eine Nutzer:innen-Beziehung zu erstellen oder zu ersetzen.

Wichtig

Data Objects ist allgemein verfügbar, aber Ihr Workspace muss für Accounts bereitgestellt sein, bevor Sie diesen Endpunkt verwenden können. Um die Bereitstellung 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.update.

Rate-Limit

Dieser Endpunkt gehört zum Schreib-Bucket für Data Objects 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.

Anfrageparameter

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

Beispielanfrage

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

Beispiel-Payload für die Anfrage

1
2
3
4
5
6
7

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "admin"
  }
}

cURL-Beispielanfrage

Dieses Beispiel ersetzt die Attribute der account_user-Beziehung zwischen dem/der Nutzer:in und acct-123 und überschreibt dabei alle zuvor darin gespeicherten Attribute.

1
2
3
4
5
6
7
8
9
10

curl --location --request PUT '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",
  "attributes": {
    "role": "admin"
  }
}'

Antwort

Dieser Abschnitt enthält eine erfolgreiche Beispielantwort und die Antwortfelder.

Beispiel für eine erfolgreiche Antwort

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

1
2
3
4
5
6
7
8
9

{
  "user_relationship": {
    "type_name": "account",
    "object_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "admin" }
  }
}

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 deren Behebung auf.