データオブジェクトの更新

このエンドポイントを使用して、既存のデータオブジェクトに属性をマージします。

重要

データオブジェクトは現在早期アクセス段階です。データオブジェクトの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": {
    "credits": 750
  }
}

サンプルcURLリクエスト

この例では、acct-123 の credits 属性を更新し、レコードの他の属性は変更しません。

1
2
3
4
curl --location --request PATCH '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": { "credits": 750 } }'

レスポンス

このセクションでは、成功レスポンスのサンプルとレスポンスフィールドについて説明します。

成功レスポンス例

ステータスコード 200 は、以下のレスポンスボディを返す可能性があります。attributes オブジェクトはマージの結果を反映しています。

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

レスポンスパラメーター

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

エラー

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