Folders

Delete a folder

Deletes a folder belonging to the specified matter.

An unknown folder id returns 400 rather than 404, because the folder may have been created but not yet processed. The change is processed asynchronously; the returned Link continues to resolve the folder with isDeleted: true once applied.

delete/matters/{matterId}/documents/folders/{folderId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring uuid required

Unique identifier of the matter.

folderIdstring uuid required

Unique identifier of the folder.

Response

When request is accepted. Returns a hypermedia 'Link' object of the folder to be deleted.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.