カスタムオブジェクトの更新

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

重要

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

サンプルcURLリクエスト

この例では、acct-123 の credits 属性を更新し、レコードの他の属性はそのまま保持します。

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

レスポンス

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

成功レスポンスの例

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

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

レスポンスパラメーター

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

エラー

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