Remplacer une relation d’objet

Utilisez cet endpoint pour créer ou remplacer une relation d’objet.

Important

Les objets de données sont disponibles pour tous, mais votre espace de travail doit être provisionné pour les comptes avant que vous puissiez utiliser cet endpoint. Pour demander le provisionnement, accédez à Paramètres des données > Comptes et remplissez le questionnaire. Pour en savoir plus, consultez Activer les comptes.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec la permission data_objects.object_relationships.update.

Limite de débit

Cet endpoint fait partie du compartiment d’écriture des objets de données, avec une limite par défaut de 1 000 requêtes par minute.

Paramètres de chemin

Le tableau suivant répertorie et décrit les paramètres de chemin de l’endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Paramètres de requête

Le tableau suivant répertorie et décrit les paramètres du corps de requête JSON de l’endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Exemple de requête

Cette section présente un exemple de payload JSON et un exemple de requête cURL.

Exemple de payload de requête

1
2
3
4
5
6

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

Exemple de requête cURL

Cet exemple remplace la relation subaccount entre acct-123 et acct-456, en écrasant tous les attributs précédemment enregistrés sur celle-ci.

1
2
3
4
5
6
7
8
9

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

Réponse

Cette section présente un exemple de réponse réussie ainsi que les champs de la réponse.

Exemple de réponse réussie

Le code de statut 200 peut renvoyer le corps de réponse suivant.

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": {}
  }
}

Paramètres de réponse

Le tableau suivant répertorie et décrit les champs d’une réponse réussie.

Erreurs

Le tableau suivant répertorie les erreurs courantes de cet endpoint et la manière de les résoudre.