Supprimer une relation utilisateur

Utilisez cet endpoint pour supprimer une relation entre un utilisateur et un objet.

Important

Les objets de données sont actuellement en accès anticipé. Votre espace de travail doit être activé avant que les permissions de clé API pour les 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 la permission data_objects.user_relationships.delete.

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 la requête JSON pour l’endpoint /data_objects/objects/{type_name}/{external_id}/users.

Remarque

Cet endpoint DELETE attend un corps de requête JSON. Vérifiez que votre client HTTP envoie bien un corps de requête lors des appels DELETE.

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
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

Exemple de requête cURL

Cet exemple supprime la relation account_user entre l’utilisateur spécifié et acct-123. Le profil utilisateur et l’enregistrement du compte sont tous deux conservés.

1
2
3
4
5
6
7
curl --location --request DELETE '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"
}'

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

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.