Passer au contenu

Supprimer des relations d’objets en masse

delete

/data_objects/object_relationships

Utilisez cet endpoint pour supprimer jusqu’à 50 relations d’objet à objet en une seule requête.

Braze accepte la requête et la traite en arrière-plan. Une réponse 202 signifie que le lot est mis en file d’attente, et non appliqué. Pour supprimer une seule relation et voir la modification immédiatement, utilisez Supprimer une relation d’objet. Pour savoir quel endpoint utiliser selon les cas, consultez Endpoints en masse.

Conditions préalables

Pour utiliser cet endpoint, vous avez besoin d’une clé API disposant de l’autorisation data_objects.object_relationships.bulk_delete. Les autorisations portant sur un seul enregistrement, comme data_objects.object_relationships.delete, ne donnent pas accès à cet endpoint.

Limite de débit

Cet endpoint fait partie du compartiment d’écriture en masse de 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 Cloud Data Ingestion des objets de données. 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 requête JSON pour l’endpoint /data_objects/object_relationships.

Paramètre Requis Type de données Description
records Requis Tableau Les relations d’objets à supprimer. Doit contenir de 1 à 50 enregistrements. Braze rejette tout autre champ de premier niveau.
records[].type_name Requis Chaîne de caractères Type de l’objet source
records[].object_id Requis Chaîne de caractères Identifiant de l’objet source
records[].rel_kind Requis Chaîne de caractères Nom du type de relation
records[].related_type_name Requis Chaîne de caractères Type de l’objet cible
records[].related_object_id Requis Chaîne de caractères Identifiant de l’objet cible

Comment Braze traite le lot

  • La validation se fait en tout ou rien. Si un enregistrement échoue à la validation, Braze rejette toute la requête avec un code 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 des types, du type de relation et de la relation au moment du traitement du lot. Une requête qui renvoie 202 peut donc ensuite produire des échecs pour certains enregistrements. Consultez Échecs de traitement.
  • Les enregistrements sont ordonnés selon leur heure de réception. Braze horodate chaque enregistrement avec l’heure de réception de 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 contient un exemple de payload JSON et un exemple de requête cURL.

Exemple de payload de requête

{
  "records": [
    {
      "type_name": "contact",
      "object_id": "contact-001",
      "rel_kind": "works_at",
      "related_type_name": "account",
      "related_object_id": "acct-001"
    }
  ]
}

Exemple de requête cURL

Cet exemple supprime la relation works_at entre contact-001 et acct-001. Les deux objets sont conservés.

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "records": [
    {
      "type_name": "contact",
      "object_id": "contact-001",
      "rel_kind": "works_at",
      "related_type_name": "account",
      "related_object_id": "acct-001"
    }
  ]
}'

Réponse

Cette section contient un exemple de réponse réussie et 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é lors du traitement d’un lot en file d’attente.

Code Signification
data-object-type-not-found type_name ou related_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 ces types.
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 dans records, à partir de 0).

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

Statut Cause Recommandation
400 Requête non valide (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), ou contient un champ d’un type incorrect ou une chaîne vide Corrigez chaque enregistrement listé et renvoyez la requête complète.
401 Clé REST API manquante ou non valide 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 requise ou la requête est bloquée par la liste d’autorisation Vérifiez que la clé dispose de data_objects.object_relationships.bulk_delete et que votre adresse IP source figure sur la liste d’autorisation de la clé, si elle est configurée.
404 Data Objects n’est pas activé pour votre entreprise Vérifiez que votre espace de travail est provisionné pour 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é.
New Stuff!