Folders

Delete Folder

Changed on

Delete a folder and every descendant.

Removes the folder identified by folder_id together with every folder beneath it, in a single transaction. Deletion is unconditional; there is no archive or unarchive step. Resources that were assigned to any of the removed folders continue to exist and are no longer reachable through the deleted folder.

delete/folders/{folder_id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/{folder_id}
  • Auth
    API key in header Authorization

Path parameters

folder_idstring uuid required

Response

Successful Response

countinteger

1 if a folder was deleted, 0 if no folder matched.

idstring uuid nullable

Id of the deleted folder. Omitted when nothing was deleted.

Changes

  • a7f9a6823230Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • 925e8b901a26Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status