Requires write_collection access scope. More access scope
The Delete Collection API allows users to delete a specific collection by providing its unique ID in the path parameter. This operation is irreversible and will remove the collection and its associated metadata from the system.#### Use Cases:
Remove outdated or irrelevant collections.
Manage and clean up collections for better organization.
Indicates the collection was successfully deleted.
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Collection not found"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
Collection Not Found
The Collection ID provided in the request does not exist.
{ "errors": ["Collection not found"] }
Invalid or empty collection_id
missing required collection_id or collection_id with incorrect UUID types
{ "errors": [ "collection_id has an invalid UUID"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
