API ReferenceFile

Delete file

In case of soft delete moves file to trash folder. For hard delete completely deletes file's metadata from pm database as well as from amazon storage This API returns a JSON response indicating success or failure.

Path parameters

fileIdstringRequiredformat: "uuid"
The unique identifier of the File to delete

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Query parameters

hardbooleanOptional
Param indicates that file should be hard deleted

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeobject or null
The HTTP code of the response.