Document Embed Update

Change the display options of a document embed. When display options are updated please allow for a few minutes propagation time before widget will pick up the changes.

Action: issuu.document_embed.update

Authentication

This method requires authentication.

Request parameters

Here is a basic example of an HTML upload form.

<form action="http://api.issuu.com/1_0" method="post">
  <input type="hidden" name="action" value="issuu.document_embed.update"/>
  <input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
  <input type="text" name="documentId"/>
  <input type="text" name="width"/>
  <input type="text" name="height"/>
  <input type="submit" value="Update"/>
</form>

Response parameters

Tells the embed widget which document embed to display | | documentId | string | Unique identifier of the document shown by the embed. If document is deleted or removed after embed was created the field will be omitted from response | | readerStartPage | integer |The page in the document which will initially be displayed. | | width | integer | Width in pixels of the widget when embedded in webpage | | height | integer | Height in pixels of the widget when embedded in webpage | | created | datetime | Timestamp for when embed was created in W3C format. |

Example responses

XML

<rsp stat="ok">
    <documentEmbed id="1000085" dataConfigId="1001221/1000085" documentId="131031162639-5aba6365a6c84fcca627ad4c5fdff4c4" readerStartPage="3" width="320" height="240" created="2013-10-31T16:32:03.000Z"/>
</rsp>

JSON

{
    "rsp": {
        "_content": {
            "documentEmbed": {
                "id": 1000085,
                "dataConfigId": "1001221/1000085",
                "documentId": "131031162639-5aba6365a6c84fcca627ad4c5fdff4c4",
                "readerStartPage": 3,
                "width": 320,
                "height": 240,
                "created": "2013-10-31T16:26:40.000Z"
            }
        },
        "stat": "ok"
    }
}

Error codes