カタログ削除

カタログを削除するには、このエンドポイントを使用する。

前提条件

このエンドポイントを使用するには、catalogs.delete パーミッションを持つAPI キーが必要です。

レート制限

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

経路パラメータ

リクエスト例

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

応答

このエンドポイントには、200 と404 の2つのステータスコード・レスポンスがある。

成功応答例

ステータスコード200 、以下のレスポンスボディを返すことができる：

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

エラー応答例

ステータスコード404 、以下のレスポンスボディを返すことができる。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照してください。

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

トラブルシューティング

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