Passer au contenu

Cette page a été traduite automatiquement et peut contenir des inexactitudes. Pour signaler une erreur de traduction, utilisez le module de commentaires en bas de la table des matières, à droite de la page.

Mettre à jour un objet de données

patch

/data_objects/objects/{type_name}/{object_id}

Utilisez cet endpoint pour fusionner des attributs dans un objet de données existant.

Important

Les objets de données sont en disponibilité générale, mais votre espace de travail doit être provisionné pour les comptes avant que vous puissiez utiliser cet endpoint. Pour demander ce provisionnement, accédez à Paramètres des données > Comptes et remplissez le questionnaire. Pour plus de détails, consultez Activer les comptes.

Conditions préalables

Pour utiliser cet endpoint, vous avez besoin d’une clé API disposant de la permission data_objects.update.

Limite de débit

Cet endpoint fait partie du compartiment d’écriture des objets de données, 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}.

Paramètre	Obligatoire	Type de données	Description
`type_name`	Obligatoire	Chaîne de caractères	Nom machine du type d’objet de données
`object_id`	Obligatoire	Chaîne de caractères	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}.

Paramètre	Obligatoire	Type de données	Description
`attributes`	Obligatoire	Objet	Champs de premier niveau à fusionner
`display_name`	Facultatif	Chaîne de caractères	Libellé d’affichage de l’objet. Lorsque le type possède un champ source pour le nom d’affichage, la valeur de ce champ est prioritaire. S’il est omis, le nom d’affichage existant est conservé

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

{
  "attributes": {
    "credits": 750
  }
}

Exemple de requête cURL

Cet exemple met à jour l’attribut credits de acct-123 sans modifier les autres attributs de l’enregistrement.

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{ "attributes": { "credits": 750 } }'

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. L’objet attributes reflète le résultat de la fusion.

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Acme", "credits": 750 }
  }
}

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
`data_object`	Obligatoire	Objet	Enregistrement de l’objet de données mis à jour
`data_object.type_name`	Obligatoire	Chaîne de caractères	Nom machine du type d’objet de données
`data_object.object_id`	Obligatoire	Chaîne de caractères	Identifiant de l’objet de données
`data_object.attributes`	Obligatoire	Objet	Attributs de l’objet après la fusion

Erreurs

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

Statut	Cause	Recommandation
`400`	Erreur de validation	Vérifiez que chaque champ de `attributes` existe dans le schéma du type et utilise le bon type de données.
`404`	Type introuvable ou objet introuvable	Vérifiez que `type_name` et `object_id` existent tous les deux dans l’espace de travail.
`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 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.update` 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.

New Stuff!