カスタムオブジェクトの置換

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

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

以下の表は、/custom_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/custom_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
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Updated Account" }
  }
}

レスポンスパラメーター

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

エラー

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