データオブジェクトを作成

このエンドポイントを使用して、特定のタイプのデータオブジェクトを1つ作成します。

重要

データオブジェクトは一般提供されていますが、このエンドポイントを使用する前に、ワークスペースでアカウントのプロビジョニングが完了している必要があります。プロビジョニングをリクエストするには、データ設定 > アカウントに移動し、アンケートに回答してください。詳細については、アカウントを有効にするを参照してください。

前提条件

このエンドポイントを使用するには、data_objects.create 権限を持つAPI キーが必要です。

レート制限

このエンドポイントはデータオブジェクト書き込みバケットに含まれており、デフォルトの制限は1分あたり1000リクエストです。

パスパラメーター

以下の表は、/data_objects/objects/{type_name} エンドポイントのパスパラメーターの一覧と説明です。

リクエストパラメーター

以下の表は、/data_objects/objects/{type_name} エンドポイントのJSONリクエストボディパラメーターの一覧と説明です。

リクエスト例

このセクションには、サンプルJSONペイロードとサンプルcURLリクエストが含まれています。

サンプルリクエストペイロード

1
2
3
4
5
6
7

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

サンプルcURLリクエスト

この例では、識別子 acct-new の account レコードを作成し、その name 属性と 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"
  }
}'

レスポンス

このセクションには、成功レスポンスのサンプルとレスポンスフィールドが含まれています。

成功レスポンス例

ステータスコード 201 は、以下のレスポンスボディを返す場合があります。

1
2
3
4
5
6
7

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

レスポンスパラメーター

以下の表は、成功レスポンスに含まれるフィールドの一覧と説明です。

エラー

以下の表は、このエンドポイントで発生する一般的なエラーとその解決方法の一覧です。