ユーザーリレーションシップの置換

このエンドポイントを使用して、ユーザーリレーションシップを1件作成または置換します。

重要

データオブジェクトは一般提供されていますが、このエンドポイントを使用する前に、ワークスペースでアカウントがプロビジョニングされている必要があります。プロビジョニングをリクエストするには、データ設定 > アカウントに移動し、アンケートに回答してください。詳細については、アカウントを有効にするを参照してください。

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

リクエスト例

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

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

1
2
3
4
5
6
7

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "admin"
  }
}

サンプル cURL リクエスト

この例では、ユーザーと acct-123 の間の account_user リレーションシップの属性を置換し、以前に保存されていた属性をすべて上書きします。

1
2
3
4
5
6
7
8
9
10

curl --location --request PUT '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": "admin"
  }
}'

レスポンス

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

成功レスポンスの例

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

1
2
3
4
5
6
7
8
9

{
  "user_relationship": {
    "type_name": "account",
    "object_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "admin" }
  }
}

レスポンスパラメーター

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

エラー

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