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

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

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

以下の表は、/custom_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": "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/custom_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",
    "external_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "admin" }
  }
}

レスポンスパラメーター

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

エラー

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