Skip to content

Créer un objet de données

post

/data_objects/objects/{type_name}

Utilisez cet endpoint pour créer un objet de données pour un type donné.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation data_objects.create.

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}.

Paramètre Obligatoire Type de données Description
type_name Obligatoire String Nom machine du type d’objet de données

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}.

Paramètre Obligatoire Type de données Description
external_id Obligatoire String Identifiant de l’objet, unique au sein du type
attributes Obligatoire Objet Valeurs associées aux noms de champs, validées par rapport au schéma du type
display_name Facultatif String 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. 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
6
7

{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}

Exemple de requête cURL

Cet exemple crée un enregistrement account avec l’identifiant acct-new et définit ses attributs name et industry.

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}'

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 201 peut renvoyer le corps de réponse suivant.

1
2
3
4
5
6
7

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-new",
    "attributes": { "name": "New Account", "industry": "software" }
  }
}

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 créé
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é, 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 Champ d’attribut inconnu ou type d’attribut non valide Vérifiez que chaque champ dans attributes existe dans le schéma du type et utilise le bon type de données.
404 Type introuvable (data-object-type-not-found) Vérifiez que type_name existe dans l’espace de travail et correspond exactement au nom machine.
409 Objet en double (duplicate-data-object) Utilisez un external_id différent, ou utilisez PUT pour remplacer l’objet existant.
422 Limite d’enregistrements atteinte (data-object-record-limit-exceeded) 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 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 ou la requête est bloquée par la liste d’autorisation Vérifiez que la clé possède l’autorisation data_objects.create 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!