Créer un objet de données

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

Important

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

Prérequis

Pour utiliser cet endpoint, vous avez besoin d’une clé API disposant de 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 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}.

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

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

{
  "object_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 '{
  "object_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",
    "object_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.

Erreurs

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