Description
Deletes a file or folder.
URL
All responses are in JSON format by default, to specify an XML response add ".xml" to the end of the method name (in this case "file_delete")
https://<yoursubdomain>.filetransfers.net/api/file_delete
Restrictions
The calling user must have:
- Access to the file's location.
- Delete permissions in the file's location.
Parameters
Bold indicates required
Parameter | Description |
---|---|
file_id | The ID of the file or folder to be delete. IDs can be retrieved from file_list. |
api_key | Your API Key. |
timestamp | The current time in Unix timestamp format. |
signature | Please see "User Authentication" for more information. |
Sample Response
Successful response In JSON:
{"fileInfo":{"fileId":1071266,"path":"\/","fileName":"recording.aiff"}}
Successful response in XML:
<fileInfo> <fileId>1071267</fileId> <path>/</path> <fileName>image.png</fileName> </fileInfo>
Error response In JSON:
{"error":{"title":"You do not have access privileges for this location","message":"Please try a different location or speak to an administrator."}}
Error response In XML:
<error> <title>You do not have access privileges for this location</title> <message>Please try a different location or speak to an administrator.</message> </error>