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

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

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

以下の表は、/custom_objects/objects/{type_name}/{external_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/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"
}'

レスポンス

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

成功レスポンスの例

ステータスコード 200 では、以下のレスポンスボディが返される可能性があります。

1
{ "deleted": true }

レスポンスパラメーター

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

エラー

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