Theme switcher

Delete a folder (async, cascades)

Header Parameters

Authorizationstring

Path Parameters

folderIdstring Required

Stable folder ID. Unchanged by rename or move. Unknown, malformed, or cross-tenant → 404 FOLDER_NOT_FOUND.

Body Parameters

dataobject

Response

202
Object

Delete queued for async processing. Poll GET /v2/admin/jobs/{jobId} using data.id (kind: folder.delete).

Response Attributes

dataobject Required
400
Object

reason / extraDetails is invalid, or reason is missing while the tenant requires one.

Response Attributes

errorsarray Required
Min items
1
401
Object

Access token is missing or invalid.

Response Attributes

errorsarray Required
Min items
1
403
Object

Authenticated but not permitted — caller is not an admin/super-admin, or the endpoint's feature permission is off.

Response Attributes

errorsarray Required
Min items
1
404
Object

{folderId} not visible to this caller (unknown, malformed, or in another tenant).

Response Attributes

errorsarray Required
Min items
1
409
Object

The folder is in use (FOLDER_IN_USE), changed under the request (FOLDER_CONFLICT; safe to retry), data.id does not match {folderId}, or data.type is not folder.

Response Attributes

errorsarray Required
Min items
1
415
Object

Request Content-Type is not application/vnd.api+json.

Response Attributes

errorsarray Required
Min items
1
422
Object

The tenant root cannot be deleted, or the subtree has more than 500 documents.

Response Attributes

errorsarray Required
Min items
1
429
Object

Too many requests; retry later.

Response Attributes

errorsarray Required
Min items
1
500
Object

Unexpected server error.

Response Attributes

errorsarray Required
Min items
1
Was this section helpful?

DELETE

/

Select
1

Response

Was this section helpful?