CMS > Collections
Delete a collection
Soft-delete a collection and all of its entries.
delete
/v1/cms/collections/{collectionId}Returns the collection once with a status of deleted. Every later request
for it — and for any entry inside it — returns 404.
There is no undelete
Deletion is soft in storage but final through the API. Nothing here can restore a deleted collection or read its entries afterwards.
Path parameters
collectionIdstringrequiredID of the collection.
Response · 200
collectionobjectrequiredShow 9 propertiesHide properties
collectionobjectrequiredidstringrequirednamestringrequireddescriptionstring | nullrequiredfieldsobject[]requiredShow 8 propertiesHide properties
fieldsobject[]requiredidstringrequiredlabelstringrequiredtypeenumrequiredOne of: text, number, boolean, date, timestamp, url, asset, select, group
requiredbooleanrequiredstatusenumrequiredOne of: active, deleted
optionsobject[] | nullrequiredShow 3 propertiesHide properties
optionsobject[] | nullrequiredvaluestringrequiredlabelstringrequiredstatusenumrequiredOne of: active, deleted
repeatedbooleanrequiredfieldsobject[] | nullrequiredShow 6 propertiesHide properties
fieldsobject[] | nullrequiredidstringrequiredlabelstringrequiredtypeenumrequiredOne of: text, number, boolean, date, timestamp, url, asset, select, group
requiredbooleanrequiredstatusenumrequiredOne of: active, deleted
optionsobject[] | nullrequireddisplayFieldIdstring | nullrequireddefaultSortobject | nullrequiredShow 2 propertiesHide properties
defaultSortobject | nullrequiredfieldIdstringrequireddirectionenumrequiredOne of: asc, desc
statusenumrequiredOne of: active, deleted
createdAtstringrequiredupdatedAtstringrequiredErrors: 400, 401, 404, 405, 429, 500. See Errors for the response shape.