API Home >> Sheet >> API Reference >> tags

Add a set of tags to a particular workbook.

 

Request URL : POST

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

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


Request parameters

To associate tags to a workbook in Zoho Sheet we need to submit a form data to Zoho Sheet with the following field:

Field	Description
tags	[string] - One or more tag(s) to be associated with this workbook. For adding multiple tags, separate them by 'space'.

Sample Form (POST Method)

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

<input type="hidden" value="tags" value="tag1 tag2 tag3">

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

</form>

Response fields

Field	Description
workbookId	Unique ID associated with the workbook.
tag	Name of one or more tag(s) that is being associated with the 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/addTags/15265000000006067">
  <result>

     <workbookId>15265000000006067</workbookId>
        <tags>
        <tag name="sales" /> 
             <tag name="forecast" />
        <tag name="monthlyfigures" />
        </tags>

  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/addTags/15265000000006067",
        "result":
        {
           "workbookId":"15265000000006067",
           "tags":
            {
                "tag":
                [
                     {
                        "name":"temperature"
                     },
                     {
                        "name":"temp"
                     },
                     {
                        "name":"converter"
                     }
                ]
            }
         }
    }
}  

Errors

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