apidocs

UpdateDocumentThumbnail API

Uploads or replaces the thumbnail image for a document. Any existing thumbnail is overwritten.

Endpoint

/srv.asmx/UpdateDocumentThumbnail

Methods

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
documentPath string Yes Full infoRouter path of the document (e.g. /Finance/Reports/Q1Summary.pdf).
thumbnailContent byte[] Yes Raw image bytes of the thumbnail. GIF format is recommended.

Response

Success Response

<root success="true" />

Error Response

<root success="false" error="Error message" />

Required Permissions

The calling user must have Change Document Properties permission on the document.

Example

Request (POST)

POST /srv.asmx/UpdateDocumentThumbnail HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123&documentPath=/Finance/Reports/Q1Summary.pdf&thumbnailContent=<base64-encoded-gif-bytes>

Notes