File

Delete file

DEL

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

fileIdstringRequired
The unique identifier of the File to delete

Query parameters

hardbooleanOptional
Param indicates that file should be hard deleted

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
DEL
$curl -X DELETE /api/data/files/fileId \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue"
12}
Built with