データオブジェクトの削除

このエンドポイントを使用して、1つのデータオブジェクトを削除します。

重要

データオブジェクトは現在、早期アクセス段階です。Data Objects APIキーのアクセス許可が設定 > APIキーに表示されるようにするには、ワークスペースを有効にする必要があります。

前提条件

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

レート制限

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

パスパラメーター

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

リクエスト例

このセクションでは、パスパラメーターのサンプルペイロードとサンプルcURLリクエストを紹介します。

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

このリクエストのパスパラメーターのリファレンスとして、以下のJSONオブジェクトを使用してください。

1
2
3
4
{
  "type_name": "account",
  "external_id": "acct-123"
}

サンプルcURLリクエスト

この例では、acct-123 のアカウントレコードを削除します。

1
2
curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

レスポンス

このセクションでは、成功レスポンスのサンプルとレスポンスフィールドを紹介します。

成功レスポンスの例

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

1
{ "deleted": true }

削除は同期的に処理されます。1つのオブジェクトを削除しても、関連するオブジェクトは削除されません。

レスポンスパラメーター

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

エラー

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