Update a document with the given information.
Action: issuu.document.update
This method requires authentication.
| Name | Data type | Description |
|---------------|-----------|----------------------------------------------|
| apiKey (r) | string | Application key for the account |
| signature (r) | string | See [Signing Requests](/signing-requests/) |
| name (r) | string | Name of the document to update |
| title | string | Title of the publication |
| tags | list | List of keywords describing the content |
| description | string | Description of the document. Max length: |
| | | 1000 characters |
| language | enum | 2 char language code. See Language Codes for |
| | | allowed values |
| category | enum | 6 digit code indicating Document category |
| type | enum | 6 digit code indicating Document type |
| publishDate | date | Datetime when this document was originally |
| | | published. Default is at the time of upload. |
| | | See Dates for formatting rules. |
| 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 |
(r): This parameter is required.
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.document.update"/>
<input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
<input type="text" name="title"/>
<textarea name="description"></textarea>
<input type="submit" value="Update"/>
</form>
| Name | Data type | Description |
|---------------|-----------|-------------------------------------------------|
| username | string | Owner of the document |
| name | string | Name of document. Combined with username this |
| | | defines documents location on Issuu: |
| | | http://issuu.com/{username}/docs/{name} |
| publicationId | string | Unique assigned id of the publication formatted |
| | | as 32 hex digits. The id remains constant for |
| | | all revisions of a publication. |
| revisionId | string | Identifier of the current revision of a |
| | | publication. When a new revision is uploaded |
| | | this id will change while the publicationId |
| | | remains constant. A revisionId is only unique |
| | | within a given publication. |
| documentId | string | Concatenated value of revisionId and |
| | | publicationId (with a hyphen in between). |
| title | string | Title of the document |
| access | enum | "public" or "private" |
| state | enum | The state of the document: |
| | | "A" - Document is active |
| | | "P" - Document is currently being processed |
| | | "F" - Document has failed conversion |
| category | enum | 6 digit code indicating Document category |
| type | enum | 6 digit code indicating Document type |
| orgDocType | enum | The format of original file |
| orgDocName | string | the original filename of the document |
| origin | enum | Parameter indicating how the document was |
| | | created: |
| | | "apiupload" |
| | | "apislurp" |
| | | "singleupload" |
| | | "multiupload" |
| | | "singleslurp" |
| | | "multisurp" |
| | | "autoslurp" (i.e. SmartLook) |
| language | enum | [Language Code](../language-codes/) for the |
| | | document |
| pageCount | integer | The number of pages in the document |
| publishDate | date | Timestamp for when this document was |
| | | published |
| description | string | Full description of the document |
| tags | list | Keywords describing the document |
| warnings | list | Properties of the original file which could |
| | | have affected the quality of the finished |
| | | document. See Conversion Warning Codes. |
| folders | list | The folders containing this documents |
XML
<rsp stat="ok">
<document
username="lekkim"
name="racing"
documentId="090623122351-f691a27cfd744b80b25a2c8f5a51d596"
title="Race cars"
access="public"
state="P"
category="012000"
type="009000"
origin="singleupload"
pageCount="0"
ep="1245759831"
description="Race cars of Le Man 2009"
>
<tags>
<tag value="cars"/>
<tag value="le man"/>
<tag value="racing"/>
</tags>
<folders>
<folder id="3935f331-5d5b-4694-86ce-6f26c6dee809"/>
</folders>
</document>
</rsp>
JSON
{
"rsp": {
"_content": {
"document": {
"username": "lekkim",
"name": "racing",
"documentId": "090623122351-f691a27cfd744b80b25a2c8f5a51d596",
"title": "Race cars",
"access": "public",
"state": "P",
"category": "012000",
"type": "009000",
"origin": "singleupload",
"pageCount": 0,
"ep": 1245759831,
"description": "Race cars of Le Man 2009",
"tags": [
"cars",
"le man",
"racing"
],
"folders": [
"3935f331-5d5b-4694-86ce-6f26c6dee809"
]
}
},
"stat": "ok"
}
}
| Code | Message |
|------|----------------------------|
| 009 | Authentication required |
| 010 | Invalid API key |
| 200 | Required field is missing |
| 201 | Invalid field format |
| 300 | Document not found |
| 307 | Document still converting |
| 308 | Document failed conversion |