Nutzer:innen-Beziehung erstellen

Verwenden Sie diesen Endpunkt, um eine:n Braze-Nutzer:in mit einem Data Object zu verknüpfen.

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.create.

Rate-Limit

Dieser Endpunkt befindet sich im 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.

Anfrageparameter

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

Beispielanfrage

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

Beispiel-Anfrage-Payload

1
2
3
4
5
6
7

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

cURL-Beispielanfrage

Dieses Beispiel verknüpft eine:n Nutzer:in mit acct-123 als account_user und speichert die role als owner.

1
2
3
4
5
6
7
8
9
10

curl --location --request POST '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": "owner"
  }
}'

Antwort

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

Beispiel einer erfolgreichen Antwort

Der Statuscode 201 kann den folgenden Antworttext 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": "owner" }
  }
}

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 auf und beschreibt, wie Sie sie beheben können.