ユーザーリレーションシップの作成

このエンドポイントを使用して、1人のBrazeユーザーを1つのデータオブジェクトにリンクします。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

リクエスト例

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

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

1
2
3
4
5
6
7
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "owner"
  }
}

サンプルcURLリクエスト

この例では、ユーザーを acct-123 に account_user としてリンクし、role を owner として記録します。

1
2
3
4
5
6
7
8
9
10
curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "owner"
  }
}'

レスポンス

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

成功レスポンスの例

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

1
2
3
4
5
6
7
8
9
{
  "user_relationship": {
    "type_name": "account",
    "external_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "owner" }
  }
}

レスポンスパラメーター

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

エラー

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