Folders Update

Update folder name or description.

Action: issuu.folder.update

Authentication

This method requires authentication.

Request parameters

This method will list the folders belonging to a user account. To list the bookmarks inside a folder use method issuu.bookmarks.list

| Name                 | Data type | Description                               |
|----------------------|-----------|-------------------------------------------|
| apiKey (required)    | string    | Application key for the account           |
| signature (required) | string    | See Signing Requests                      |
| folderId (required)  | string    | The folder to be updated                  |
| folderName           | string    | New name of the folder. If this parameter |
|                      |           | is omitted the original name will be kept |
| folderDescription    | string    | New description of the folder. If this    |
|                      |           | field is omitted the original description |
|                      |           | will be kept                              |
| format               | enum      | Must be "xml" or "json" - default is      |
|                      |           | "xml". See Getting Started for further    |
|                      |           | details                                   |
| jsonCallback         | string    | Function wrapper for JSONP requests. See  |
|                      |           | Getting Started for further details       |

Here is a basic example of an HTML form.

<form action="http://api.issuu.com/1_0" method="get">
  <input type="hidden" name="action" value="issuu.folder.update"/>
  <input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
  <input type="hidden" name="folderId" value="4c3ba964-60c3-4349-94d0-ff86db2d47c9"/>
  <input type="text" name="folderName"/>
  <input type="text" name="folderDescription"/>
  <input type="submit" value="Update"/>
</form>

Response parameters

| Name        | Data type | Description                           |
|-------------|-----------|---------------------------------------|
| folderId    | string    | Unique identifier of the folder       |
| username    | string    | Owner of the folder                   |
| name        | string    | Name of the folder                    |
| description | string    | Description of folder content         |
| items       | integer   | Number of bookmarks in folder         |
| created     | date      | Timestamp for when folder was created |

Example responses

XML

<rsp stat="ok">
    <folder
        folderId="4c3ba964-60c3-4349-94d0-ff86db2d47c9"
        username="ferrogate"
        name="Cool stuff"
        description="Stuff I have collected"
        items="0"
        created="2009-07-12T19:52:15.000Z"
    />
</rsp>

JSON

{
    "rsp": {
        "_content": {
            "folder": {
                "folderId": "4c3ba964-60c3-4349-94d0-ff86db2d47c9",
                "username": "ferrogate",
                "name": "Cool stuff",
                "description": "Stuff I have collected",
                "items": 0,
                "created": "2009-07-12T19:52:15.000Z"
            }
        },
        "stat": "ok"
    }
}

Error codes

| Code | Message                   |
|------|---------------------------|
| 009  | Authentication required   |
| 010  | Invalid API key           |
| 200  | Required field is missing |
| 201  | Invalid field format      |