Trash a document

This method moves a document to the trash folder.


Method: document.trash


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: Returns an error if an invalid document id was passed


Message: Returns a message indicating the document was trashed. No message will be present if errors occurred

Example Request

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>document.trash</methodName> <params><param> <value><struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>id</name> <value><int>2161</int></value> </member> </struct></value> </param></params></methodCall>

Example Response

<struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>messages</name> <value><array><data> <value><string>Document moved to trash</string></value> </data></array></value> </member> <member> <name>api_status</name> <value><int>200</int></value> </member></struct>

Trash a Folder

This method moves a folder to the trash folder group. The folder must be empty of documents.


Method: folder.trash


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: An error will be returned if the folder is not empty


Message: Returns a message indicating the group was deleted.

Example Request

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>folder.trash</methodName> <params><param> <value><struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>id</name> <value><int>265</int></value> </member> </struct></value> </param></params></methodCall>

Example Response 

<struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>messages</name> <value><array><data> <value><string>Folder “7497_testfolder_199” Moved to Trash</string></value> </data></array></value> </member> <member> <name>api_status</name> <value><int>200</int></value> </member></struct>

Thank you! Your feedback will help us to improve this guide.

Was this page helpful?


We're sorry to hear that

If you have the time, we'd love to know how we could improve it.

Need to contact a human?

Get in touch