カタログアイテムの削除

このエンドポイントを使用して、カタログ内の項目を削除します。

前提条件

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

レート制限

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints, as documented in API rate limits.

パスパラメータ

要求パラメータ

このエンドポイントのリクエストボディはありません。

リクエスト例

1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

レスポンス

このエンドポイントには、202、400、404 の3 つのステータスコード応答があります。

成功応答の例

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

1
2
3
{
  "message": "success"
}

エラーレスポンス例

ステータスコード400 は、以下のレスポンスボディを返す可能性があります。発生する可能性のあるエラーの詳細については、トラブルシューティングを参照してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "errors": [
    {
      "id": "item-not-found",
      "message": "Could not find item",
      "parameters": [
        "item_id"
      ],
      "parameter_values": [
        "restaurant34"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

次の表に、返される可能性のあるエラーと関連するトラブルシューティング手順を示します。