Delete a collection
DELETE/v1/collections/{id}
Irreversible. Send confirm=true as a query parameter or X-Confirm: true.
Needs an API key. Send it in the Authorization: Bearer header.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id required | Path | string | |
confirm optional | Query | boolean | |
X-Confirm optional | Header | string | One of: true |
Responses
200Deleted, with item and license-record counts.object · Content: application/json
Name Type Description deletedrequiredboolean items_deletedrequiredinteger license_records_deletedrequiredinteger 400The collection request is not valid.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time. 401The API key is missing, not valid, or revoked.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time. 404The collection or item was not found or is not owned by this account.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time. 429Over your plan's limit. Free accounts get 20 calls per minute and 300 calls per day. Pro accounts get 60 calls per minute and 20,000 calls per month (UTC). MCP and the API share one allowance per account. The Retry-After header gives the seconds to wait, up to 86,400, and the limit and reset_at fields in the body name the limit you hit and when it resets.Schema Error · Content: application/json
Error fields (8)
Name Type Description errorrequiredstring A short code: missing_api_key, invalid_api_key, invalid_parameter, invalid_filter_for_kind, not_found, rate_limited, method_not_allowed, or internal_error. messagerequiredstring What went wrong, in plain words. parameteroptionalstring On invalid_parameter and invalid_filter_for_kind, the invalid parameter or field. invalid_valuesoptionalarray of string Unknown controlled filter ids. discoveryoptionalstring The endpoint listing valid filter ids and labels. limitoptionalstring Only on rate_limited: which limit you hit. One of: minute, day, month retry_afteroptionalnumber Only on rate_limited: seconds to wait before retrying. reset_atoptionalstring Only on rate_limited: when that limit resets, as an ISO 8601 UTC time.
{
"deleted": true,
"items_deleted": 1,
"license_records_deleted": 1
} Copy only. No request is sent from this page, so your key never goes into a web page. The samples read it from the UNCOMMON_EAR_API_KEY environment variable.