Objektbeziehung aktualisieren

Verwenden Sie diesen Endpunkt, um Attribute in eine bestehende Objektbeziehung zusammenzuführen.

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.object_relationships.update.

Rate-Limit

Dieser Endpunkt gehört zum Schreib-Bucket für Data Objects mit einem Standardlimit von 1.000 Anfragen pro Minute.

Pfadparameter

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

Anfrageparameter

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

Beispielanfrage

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

Beispiel-Payload der Anfrage

1
2
3
4
5
6

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}

cURL-Beispielanfrage

Dieses Beispiel führt Attribute in die bestehende subaccount-Beziehung zwischen acct-123 und acct-456 zusammen. Attribute, die Sie weglassen, bleiben unverändert.

1
2
3
4
5
6
7
8
9

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}'

Antwort

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

Beispiel einer erfolgreichen Antwort

Der Statuscode 200 kann den folgenden Antworttext zurückgeben.

1
2
3
4
5
6
7
8
9
10
11

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "object_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

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.