API Home >> Sheet >> API Reference >> books

To trash a particular workbook i.e. move it to the trash folder.

 
Request URL : POST

                                XML : http://sheet.zoho.com/api/private/xml/trashbook/[BookID]?apikey=[API Key]&ticket=[Ticket]

                                JSON : http://sheet.zoho.com/api/private/json/trashbook/[BookID]?apikey=[API Key]&ticket=[Ticket]


Request parameters

To trash a particular workbook we need to submit a form data as mentioned below:

Sample Form (POST Method)

<form method="POST"    action="http://sheet.zoho.com/api/private/xml/trashbook/15265000000006067?apikey=[APIKEY]&ticket=[Ticket]">

<input type="submit" value="TrashBook" class="divbutton" name="submit">

</form>

Response fields

Field	Description
workbookId	Unique ID associated with the workbook that is being trashed.
workbookName	Name of the trashed workbook.

Sample Response

The following is the sample XML response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/trashbook/15265000000006067">
  <result>

     <workbookId>15265000000006067</workbookId>
        <workbookName>TempConverter</workbookName> 

  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/trashbook/15265000000006067",
        "result":
        {   
            "workbookId":"15265000000006067",
            "workbookName":"TempConverter"
        }
    }
}  

Errors

Trashing a workbook method may return general errors. Other specific HTTP error codes include 2851,2852, 2853 & 2854.