オブジェクトリレーションシップの削除

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

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

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

注

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

リクエスト例

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

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

1
2
3
4
5

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}

サンプルcURLリクエスト

この例では、acct-123 と acct-456 間の subaccount リレーションシップを削除します。両方のアカウントレコードはそのまま残ります。

1
2
3
4
5
6
7
8

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}'

レスポンス

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

成功レスポンス例

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

1

{ "deleted": true }

レスポンスパラメーター

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

エラー

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