deleteFolder

@DELETE(value = folders/{folderId})
abstract suspend fun deleteFolder(@Path(value = folderId) folderId: String, @Query(value = deleteDocuments) deleteDocuments: Boolean? = false, @Body() folderDeleteRequestDto: FolderDeleteRequestDto? = null): Response<EmptyObjectResponseDto>
Content copied to clipboard

Delete a folder for a user This endpoint allows you to delete a folder from the authenticating user&#39;s account. Responses:

  • 200: Success. The folder was successfully removed.

  • 401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.

  • 404: Not Found. The folderID you have provided is not one of this user's folders. See the user object for a list of their folders.

Return

EmptyObjectResponseDto

Parameters

folderId

A unique ID that identifies this folder in the Sensibill system.

deleteDocuments

Soft delete any documents that are in this folder. This means the document will stay in Sensibill&#39;s system but it will not be accessible by the user. This may be passed as a query parameter or in a JSON body in the request. (optional, default to false)

folderDeleteRequestDto

Delete a folder for a user (optional)