Skip to content

複数のカタログ項目を削除する

delete

/catalogs/{catalog_name}/items

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

各リクエストは最大50個の項目をサポートできます。このエンドポイントは非同期です。

前提条件

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

レート制限

このエンドポイントには、APIレート制限に記載されているように、すべての非同期カタログアイテムエンドポイント間で1分あたり16,000リクエストの共有レート制限があります。

パスパラメーター

パラメーター 必須 データタイプ 説明
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"}
  ]
}'

応答

このエンドポイントには、202400404 の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!