Passer au contenu

Supprimer des objets de données en masse

delete

/data_objects/objects

Utilisez cet endpoint pour supprimer jusqu’à 50 objets de données, de n’importe quelle combinaison de types, 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 en file d’attente, et non qu’il a été appliqué. Pour supprimer un seul objet de données et voir la modification immédiatement, utilisez Supprimer un objet de données. 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.bulk_delete. Les autorisations pour un seul enregistrement, comme data_objects.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 ainsi qu’avec les synchronisations d’objets de données via Cloud Data Ingestion, et elle est distincte de la limite d’écriture pour un seul enregistrement.

Paramètres de la 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.

Paramètre Requis Type de données Description
records Obligatoire Tableau Les objets de données à supprimer. Doit contenir de 1 à 50 enregistrements. Braze rejette tout autre champ de premier niveau.
records[].type_name Obligatoire Chaîne de caractères Le nom machine du type d’objet de données
records[].object_id Obligatoire Chaîne de caractères Votre identifiant pour l’objet, soit la même valeur que object_id dans les chemins des endpoints pour un seul enregistrement

Comment Braze traite le lot

  • La validation fonctionne en tout ou rien. Si un enregistrement échoue à la validation, Braze rejette l’ensemble de 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 de chaque type et de chaque objet au moment où il traite le lot : une requête qui renvoie 202 peut donc encore générer des échecs pour certains enregistrements par la suite. Consultez Échecs de traitement.
  • Les enregistrements sont ordonnés selon l’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 le même objet, celle que Braze a reçue en dernier l’emporte, et Braze ignore toute écriture plus ancienne qui arrive ensuite.
  • Les suppressions peuvent être mises en attente. La suppression d’un objet 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 l’objet n’existe toujours pas après ce délai, l’enregistrement échoue avec data-object-dependency-not-found.
  • Un upsert reçu après la suppression du même objet recrée cet objet.

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"},
    {"type_name": "opportunity", "object_id": "opp-001"}
  ]
}

Exemple de requête cURL

Cet exemple supprime un enregistrement account et un enregistrement opportunity dans la même requête.

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

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": 2
}

Paramètres de la 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 Obligatoire Chaîne de caractères L’identifiant généré par Braze pour cette requête. Chaque requête constitue sa propre importation.
status Obligatoire Chaîne de caractères Toujours queued. Le lot est accepté et en attente de traitement.
record_count Obligatoire 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-ingestion-rejected Tout autre rejet, par exemple un object_id refusé.
data-object-dependency-not-found L’objet é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 d’un enregistrement, l’index de cet enregistrement (sa position, à partir de 0, dans records).

Le tableau suivant répertorie les erreurs courantes pour cet endpoint et la façon 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 comporte 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 Incompatibilité de schéma (schema-mismatch) : un enregistrement ne contient pas un champ obligatoire, contient un champ non reconnu (y compris updated_at), ou contient un champ du mauvais type ou une chaîne vide Corrigez chaque enregistrement listé et renvoyez la requête complète.
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 requise ou la requête est bloquée par la liste d’autorisation Vérifiez que la clé dispose de l’autorisation data_objects.bulk_delete et que votre adresse IP source figure dans 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 les comptes.
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!