Skip to content

Remplacer un objet de données

put

/data_objects/objects/{type_name}/{external_id}

Utilisez cet endpoint pour créer ou remplacer un objet de données avec une sémantique de remplacement complet des attributs.

Prérequis

Pour utiliser cet endpoint, vous avez besoin d’une clé API avec 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 50 requêtes par minute.

Paramètres de chemin

Le tableau suivant répertorie et décrit les paramètres de chemin pour l’endpoint /data_objects/objects/{type_name}/{external_id}.

Paramètre Obligatoire Type de données Description
type_name Obligatoire String Nom machine du type d’objet de données
external_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 pour l’endpoint /data_objects/objects/{type_name}/{external_id}.

Paramètre Obligatoire Type de données Description
attributes Obligatoire Objet Attributs complets de l’objet. Les champs omis sont effacés
display_name Facultatif String Libellé d’affichage de l’objet. Lorsque le type possède un champ source de nom d’affichage, la valeur de ce champ prévaut. Valeur par défaut : external_id

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

1
2
3
4
5

{
  "attributes": {
    "name": "Updated Account"
  }
}

Exemple de requête cURL

Cet exemple remplace les attributs stockés sur acct-123 par ceux contenus dans le payload. Si aucun enregistrement avec cet identifiant n’existe, cette requête le crée.

1
2
3
4
5
6
7
8

curl --location --request PUT '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": {
    "name": "Updated Account"
  }
}'

Réponse

Cette section comprend un exemple de réponse réussie et les champs de réponse.

Exemple de réponse réussie

Le code de statut 200 peut renvoyer le corps de réponse suivant. Cet endpoint renvoie 200 que la requête ait créé ou remplacé l’objet.

1
2
3
4
5
6
7

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

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 d’objet de données créé ou remplacé
data_object.type_name Obligatoire String Nom machine du type d’objet de données
data_object.external_id Obligatoire String Identifiant de l’objet de données
data_object.attributes Obligatoire Objet Attributs de l’objet stockés et indexés par nom de champ

Erreurs

Le tableau suivant répertorie les erreurs courantes pour cet endpoint et comment les résoudre.

Statut Cause Recommandation
400 Erreur de validation Confirmez que chaque champ dans attributes existe dans le schéma du type et utilise le type de données correct.
404 Type introuvable (data-object-type-not-found) Confirmez que type_name existe dans l’espace de travail et correspond exactement au nom machine.
422 Limite d’enregistrements atteinte (data-object-record-limit-exceeded) lorsque cette requête créerait un nouvel objet Réduisez le nombre d’objets pour le type, ou contactez le support Braze concernant les limites de votre espace de travail.
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 ou la requête est bloquée par la liste d’autorisation Confirmez que la clé possède la permission data_objects.update et que votre adresse IP source figure dans la liste d’autorisation de la clé, si elle 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!