複数のカタログ項目を削除する
delete
/catalogs/{catalog_name}/items
カタログの複数の項目を削除するには、このエンドポイントを使用する。
各リクエストは最大50個の項目まで対応できます。このエンドポイントは非同期である。
前提条件
このエンドポイントを使用するには、API キーとcatalogs.delete_items
の権限が必要です。
レート制限
パスパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
catalog_name |
必須 | 文字列 | カタログ名。 |
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
items |
必須 | 配列 | アイテム・オブジェクトを含む配列。項目オブジェクトには、Braze が削除すべき項目を参照する id が含まれている必要があります。リクエストごとに最大 50 個のアイテムオブジェクトが許可されます。 |
例のリクエスト
1
2
3
4
5
6
7
8
9
10
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"items": [
{"id": "restaurant1"},
{"id": "restaurant2"},
{"id": "restaurant3"}
]
}'
応答
このエンドポイントには、202
、400
、404
という 3 つのステータスコード応答があります。
成功応答の例
ステータスコード 202
は、次の応答本文を返す可能性があります。
1
2
3
{
"message": "success"
}
エラー応答例
ステータスコード 400
は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。
1
2
3
4
5
6
7
8
9
10
11
{
"errors": [
{
"id": "items-missing-ids",
"message": "There are 1 item(s) that do not have ids",
"parameters": [],
"parameter_values": []
}
],
"message": "Invalid Request",
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング |
---|---|
catalog-not-found |
カタログ名が有効であることを確認する。 |
ids-too-large |
項目 ID は250文字以内にする必要があります。 |
ids-not-unique |
項目 ID がリクエスト内で一意であることを確認します。 |
ids-not-strings |
項目 ID は文字列型でなければなりません。 |
items-missing-ids |
アイテムIDを持たないアイテムがある。各項目が項目 ID を持っていることを確認します。 |
invalid-ids |
項目 ID には、英字、数字、ハイフン、アンダースコアのみを使用できます。 |
request-includes-too-many-items |
あなたのリクエストは項目が多すぎます。リクエストごとの項目の上限は50個です。 |
New Stuff!