ユーザーリレーションシップの削除

このエンドポイントを使用して、ユーザーとオブジェクト間のリレーションシップを1つ削除します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

注

この DELETE エンドポイントにはJSONリクエストボディが必要です。お使いのHTTPクライアントが DELETE 呼び出しでリクエストボディを送信することを確認してください。

リクエスト例

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

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

1
2
3
4

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

サンプルcURLリクエスト

この例では、指定されたユーザーと acct-123 の間の account_user リレーションシップを削除します。ユーザープロファイルとアカウントレコードはどちらもそのまま残ります。

1
2
3
4
5
6
7

curl --location --request DELETE '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"
}'

レスポンス

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

成功レスポンス例

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

1

{ "deleted": true }

レスポンスパラメーター

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

エラー

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