データオブジェクトの置換

このエンドポイントを使用して、全属性置換セマンティクスでデータオブジェクトを作成または置換します。

重要

データオブジェクトは現在早期アクセス段階です。Data Objects APIキーの権限が設定 > APIキーに表示されるには、ワークスペースが有効になっている必要があります。

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

リクエスト例

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

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

1
2
3
4
5
{
  "attributes": {
    "name": "Updated Account"
  }
}

サンプルcURLリクエスト

この例では、acct-123 に保存されている属性をペイロード内の属性に置換します。その識別子を持つレコードが存在しない場合、このリクエストによって新規作成されます。

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"
  }
}'

レスポンス

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

成功レスポンスの例

ステータスコード 200 は以下のレスポンスボディを返す可能性があります。このエンドポイントは、リクエストがオブジェクトを作成した場合でも置換した場合でも 200 を返します。

1
2
3
4
5
6
7
{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

レスポンスパラメーター

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

エラー

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