Supprimer des relations utilisateur en masse
/data_objects/user_relationships
Utilisez cet endpoint pour supprimer jusqu’à 50 relations utilisateur-objet en une seule requête.

Les Data Objects sont disponibles pour tous, mais votre espace de travail doit être provisionné pour les 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 les Accounts.
Braze accepte la requête et la traite en arrière-plan. Une réponse 202 signifie que le lot est en file d’attente, pas qu’il a été appliqué. Pour supprimer une seule relation et voir la modification immédiatement, utilisez Supprimer une relation utilisateur. Pour savoir quand utiliser l’un ou l’autre, consultez Endpoints en masse.
Conditions préalables
Pour utiliser cet endpoint, vous avez besoin d’une clé API disposant de l’autorisation data_objects.user_relationships.bulk_delete. Les autorisations portant sur un seul enregistrement, comme data_objects.user_relationships.delete, ne donnent pas accès à cet endpoint.
Limite de débit
Cet endpoint fait partie du compartiment d’écriture en masse des Data Objects, avec une limite par défaut de 1 000 requêtes par minute et par espace de travail. Cette limite est partagée entre les six endpoints en masse et avec les synchronisations de Data Objects via Cloud Data Ingestion. Elle est distincte de la limite d’écriture pour un seul enregistrement.
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/user_relationships.
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
records |
Requis | Tableau | Les relations utilisateur à supprimer. Doit contenir entre 1 et 50 enregistrements. Braze rejette tout autre champ de premier niveau. |
records[].type_name |
Requis | Chaîne de caractères | Type de l’objet auquel l’utilisateur est lié |
records[].object_id |
Requis | Chaîne de caractères | Identifiant de l’objet auquel l’utilisateur est lié |
records[].rel_kind |
Requis | Chaîne de caractères | Nom du type de relation |
records[].user |
Requis | Objet | L’utilisateur lié. Doit contenir exactement un des champs suivants : external_id, braze_id, email, phone ou alias. Envoyer zéro ou plus d’un identifiant génère une erreur. |
records[].user.external_id |
Facultatif | Chaîne de caractères | L’ID externe de l’utilisateur |
records[].user.braze_id |
Facultatif | Chaîne de caractères | L’ID utilisateur Braze |
records[].user.email |
Facultatif | Chaîne de caractères | L’adresse e-mail de l’utilisateur |
records[].user.phone |
Facultatif | Chaîne de caractères | Le numéro de téléphone de l’utilisateur |
records[].user.alias |
Facultatif | Objet | Objet alias d’utilisateur avec alias_name et alias_label (tous deux requis s’il est utilisé) |
Lorsqu’une adresse e-mail ou un numéro de téléphone correspond à plusieurs utilisateurs, les règles standard de sélection de profil de Braze déterminent l’utilisateur concerné.
Comment Braze traite le lot
- La validation fonctionne en tout ou rien. Si un enregistrement échoue à la validation, Braze rejette l’intégralité de la requête avec une erreur
400, n’enregistre rien et liste toutes les erreurs. Corrigez les erreurs et renvoyez la requête complète. - Les vérifications ont lieu pendant le traitement. Braze vérifie l’existence du type, du type de relation, de l’objet, de l’utilisateur et de la relation au moment où il traite le lot. Une requête qui renvoie
202peut donc encore produire des échecs pour certains enregistrements par la suite. Consultez Échecs de traitement. - Les enregistrements sont ordonnés selon leur heure de réception. Braze horodate chaque enregistrement avec l’heure à laquelle il a reçu la requête : n’envoyez donc pas
updated_at. Braze rejette toute requête qui l’inclut. Lorsque deux requêtes modifient la même relation, celle que Braze a reçue en dernier l’emporte, et Braze ignore une écriture plus ancienne qui arrive ensuite. - Les suppressions peuvent être mises en attente. La suppression d’une relation qui n’existe pas encore est mise en attente au lieu d’échouer immédiatement. Braze effectue de nouvelles tentatives pendant environ 40 heures (10 tentatives). Si la relation n’existe toujours pas après ce délai, l’enregistrement échoue avec
data-object-dependency-not-found.
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
{
"records": [
{"type_name": "account", "object_id": "acct-001", "rel_kind": "owns", "user": {"external_id": "user-1"}}
]
}
Exemple de requête cURL
Cet exemple supprime la relation owns entre l’utilisateur ayant l’ID externe user-1 et acct-001. 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/user_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"records": [
{"type_name": "account", "object_id": "acct-001", "rel_kind": "owns", "user": {"external_id": "user-1"}}
]
}'
Réponse
Cette section comprend 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 202 peut renvoyer le corps de réponse suivant.
{
"source_import_id": "api-20261022T153012123456-9f3a1c2b",
"status": "queued",
"record_count": 1
}
Paramètres de réponse
Le tableau suivant répertorie et décrit les champs d’une réponse réussie.
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
source_import_id |
Requis | Chaîne de caractères | L’identifiant généré par Braze pour cette requête. Chaque requête constitue sa propre importation. |
status |
Requis | Chaîne de caractères | Toujours queued. Le lot est accepté et en attente de traitement. |
record_count |
Requis | Entier | Le nombre d’enregistrements dans la requête |
Échecs de traitement
Braze ne renvoie pas ces codes depuis l’endpoint. Il les enregistre pour chaque enregistrement concerné lorsqu’il traite un lot en file d’attente.
| Code | Signification |
|---|---|
data-object-type-not-found |
type_name ne correspond à aucun type actif dans l’espace de travail. |
data-object-relationship-type-not-found |
rel_kind ne correspond à aucun type de relation actif pour ce type. |
data-object-invalid-user-identifier |
L’identifiant utilisateur ne permet pas de trouver un utilisateur. |
data-object-ingestion-rejected |
Tout autre rejet. |
data-object-dependency-not-found |
La relation était toujours introuvable après environ 40 heures de nouvelles tentatives. |
Erreurs
Une réponse 400 signifie que Braze n’a rien enregistré. Chaque erreur comporte un id, un message, le parameter en cause le cas échéant et, pour les erreurs au niveau de l’enregistrement, l’index de l’enregistrement (sa position, à partir de 0, dans records). Le parameter reprend les noms de votre requête, comme user.external_id.
Le tableau suivant répertorie les erreurs courantes pour cet endpoint et la manière de les résoudre.
| Statut | Cause | Conseils |
|---|---|---|
400 |
Requête invalide (invalid-request) : le corps n’est pas un objet JSON ou contient du JSON mal formé, records est absent ou contient moins de 1 ou plus de 50 entrées, ou le corps contient un champ défini par Braze (source_type, source_import_id, source_chunk_id ou record_type) |
Envoyez un objet JSON dont le seul champ est records, avec 1 à 50 enregistrements. |
400 |
Non-concordance de schéma (schema-mismatch) : un enregistrement ne contient pas un champ requis, contient un champ non reconnu (y compris updated_at), contient un champ de type incorrect ou une chaîne vide, ou contient un objet user avec plus d’un identifiant |
Corrigez chaque enregistrement listé et renvoyez la requête complète. |
400 |
Identifiant utilisateur manquant (missing-user-identifier) : l’objet user d’un enregistrement ne contient aucun identifiant |
Envoyez exactement un identifiant dans l’objet user de chaque enregistrement. |
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 l’autorisation nécessaire ou la requête est bloquée par la liste d’autorisation | Vérifiez que la clé dispose de data_objects.user_relationships.bulk_delete et que votre adresse IP source figure dans la liste d’autorisation de la clé, si celle-ci est configurée. |
404 |
Les Data Objects ne sont pas activés pour votre entreprise | Vérifiez que votre espace de travail est provisionné pour les Accounts. |
429 |
Limite de débit dépassée | Réessayez après X-RateLimit-Reset et réduisez la fréquence des requêtes. |
500 |
Le lot n’a pas pu être accepté (internal-error) |
Braze n’a rien accepté : vous pouvez donc réessayer la requête en toute sécurité. |