Sensibill Rest API/com.getsensibill.rest.generated.v2.api/FoldersApi/deleteFolders

deleteFolders

@DELETE(value = "folders")
abstract suspend fun deleteFolders(@Query(value = "folders") folders: String, @Query(value = "deleteDocuments") deleteDocuments: Boolean? = false): Response<EmptyObjectResponseDto>

Delete multiple folders for a user This endpoint allows you to perform a batch deletion of folders on a User object. Responses:

  • 200: Success. The folders were 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. One or more folderIDs you have provided in the request do not belong to this user. See the user object for a list of their folders.

Return

EmptyObjectResponseDto

Parameters

folders

This is a list of folder IDs that you want deleted. It should be either an array in JSON form, or a comma separated list and may be passed as a query parameter or in a JSON body in the request.

deleteDocuments

Soft delete any documents that are in this folder. This means the document will stay in Sensibill'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)

foldersDeleteRequestDto

Delete multiple folders for a user (optional)