Supprimer une relation utilisateur
/data_objects/objects/{type_name}/{object_id}/users
Utilisez cet endpoint pour supprimer une relation entre un utilisateur et un objet.

Data Objects est disponible pour tous, mais votre espace de travail doit être provisionné pour Accounts avant que vous puissiez utiliser cet endpoint. Pour demander le provisionnement, accédez à Paramètres des données > Accounts et remplissez le questionnaire. Pour plus de détails, consultez Activer Accounts.
Conditions préalables
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 Data Objects, 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}/users.
| Paramètre | Obligatoire | Type de données | Description |
|---|---|---|---|
type_name |
Obligatoire | String | Type d’objet |
object_id |
Obligatoire | String | Identifiant de l’objet |
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}/users.
| Paramètre | Obligatoire | Type de données | Description |
|---|---|---|---|
user |
Obligatoire | Object | L’utilisateur à associer à l’objet. Doit contenir exactement un des champs suivants : external_id, braze_id, alias, email ou phone. |
user.external_id |
Facultatif | String | L’ID externe de l’utilisateur. |
user.braze_id |
Facultatif | String | L’ID utilisateur Braze. |
user.alias |
Facultatif | Object | Objet alias d’utilisateur avec alias_name et alias_label (tous deux obligatoires s’il est utilisé). |
user.email |
Facultatif | String | L’adresse e-mail de l’utilisateur. |
user.phone |
Facultatif | String | Le numéro de téléphone de l’utilisateur. Doit pouvoir être converti au format E.164. |
rel_kind |
Obligatoire | String | Type de relation |
Identifier l’utilisateur
- Transmettez exactement un identifiant dans
user. Si aucun identifiant non nul n’est fourni, ou s’il y en a plusieurs, une erreur400est renvoyée. Les champs d’identifiant nuls accompagnant un identifiant valide sont acceptés. - Si une adresse e-mail ou un numéro de téléphone correspond à plusieurs profils utilisateur, Braze sélectionne l’utilisateur identifié (celui qui possède un
external_id). En cas d’égalité persistante, Braze sélectionne le profil mis à jour le plus récemment. - Utilisez
external_idlorsqu’il est disponible.

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
{
"user": {
"external_id": "user-123"
},
"rel_kind": "account_user"
}
Autre exemple utilisant un alias d’utilisateur :
{
"user": {
"alias": {
"alias_name": "[email protected]",
"alias_label": "crm_email"
}
},
"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.
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 '{
"user": {
"external_id": "user-123"
},
"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.
{ "deleted": true }
Paramètres de réponse
Le tableau suivant répertorie et décrit les champs d’une réponse réussie.
| Paramètre | Obligatoire | Type de données | Description |
|---|---|---|---|
deleted |
Obligatoire | Boolean | Indique si la suppression de la relation a réussi |
Erreurs
Le tableau suivant répertorie les erreurs courantes de cet endpoint et la manière de les résoudre.
| Statut | Cause | Recommandation |
|---|---|---|
400 |
user manquant ou vide, aucun identifiant, plus d’un identifiant, identifiant vide, braze_id, email ou alias mal formé, numéro de téléphone impossible à convertir au format E.164, ou ancien corps avec braze_id au niveau supérieur |
Envoyez un objet user contenant exactement un identifiant valide. |
400 |
rel_kind inconnu pour ce type |
Vérifiez que rel_kind est valide pour le type d’objet. |
404 |
Relation, objet ou utilisateur introuvable (user-not-found) |
Vérifiez que l’objet, l’utilisateur et les valeurs de clé de relation existent bien. |
401 |
Clé REST API manquante ou invalide | Vérifiez que l’en-tête Authorization utilise Bearer YOUR_REST_API_KEY et que la clé est active. |
403 |
La clé API ne dispose pas de la permission requise ou la requête est bloquée par la liste d’autorisation | Vérifiez que la clé dispose de la permission data_objects.user_relationships.delete et que votre adresse IP source figure dans la liste d’autorisation de la clé, si celle-ci est configurée. |
429 |
Limite de débit dépassée | Réessayez après X-RateLimit-Reset et réduisez la fréquence des requêtes. |