カタログ項目を削除する
delete
/catalogs/{catalog_name}/items/{item_id}
カタログの項目を削除するには、このエンドポイントを使う。
前提条件
このエンドポイントを使用するには、API キーとcatalogs.delete_item
の権限が必要です。
レート制限
パスパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
catalog_name |
必須 | 文字列 | カタログ名。 |
item_id |
必須 | 文字列 | カタログ項目のID。 |
リクエストパラメーター
このエンドポイントにはリクエストボディがない。
例のリクエスト
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"
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング |
---|---|
arbitrary-error |
任意のエラーが発生した。もう一度試すか、サポートに連絡する。 |
catalog-not-found |
カタログ名が有効であることを確認する。 |
item-not-found |
削除する項目がカタログに存在することを確認します。 |
New Stuff!