カスタムオブジェクトの作成

このエンドポイントを使用して、あるタイプに対して1つのカスタムオブジェクトを作成します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

リクエスト例

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

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

1
2
3
4
5
6
7
{
  "external_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/custom_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}'

レスポンス

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

成功レスポンスの例

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

1
2
3
4
5
6
7
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-new",
    "attributes": { "name": "New Account", "industry": "software" }
  }
}

レスポンスパラメーター

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

エラー

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