Remplacer une relation utilisateur

Utilisez cet endpoint pour créer ou remplacer une relation utilisateur.

Important

Les objets de données sont actuellement en accès anticipé. Votre espace de travail doit être activé avant que les autorisations de clé API des objets de données n’apparaissent dans Paramètres > Clés API.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation data_objects.user_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 50 requêtes par minute.

Paramètres de chemin

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

Paramètres de requête

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

Exemple de requête

Cette section comprend un exemple de payload JSON et un exemple de requête cURL.

Exemple de payload de requête

1
2
3
4
5
6
7
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "admin"
  }
}

Exemple de requête cURL

Cet exemple remplace les attributs de la relation account_user entre l’utilisateur et acct-123, en écrasant tous les attributs précédemment stockés.

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"
  }
}'

Réponse

Cette section comprend un exemple de réponse réussie et 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
{
  "user_relationship": {
    "type_name": "account",
    "external_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "admin" }
  }
}

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 pour cet endpoint et comment les résoudre.