Skip to navigation

Update Document Sidebar Fields

View as Markdown

Update sidebar field values for a document scanned with a custom model. Omit qid or send null to use the document’s current queue. If you supply qid, it must match the document’s current queue. You must have access to that queue.

Each fieldUuid must identify a field in the applicable model. The API rejects locked fields and duplicate updates to the same field.

Authentication

x-api-keystring
API key issued by Staple.
AuthorizationBearer
JWT obtained from the login endpoint.

Request

This endpoint expects an object.
documentIdintegerRequired
fieldslist of objectsRequired
qidinteger or nullOptional
Queue ID. Omit or set to null to use the document's current queue. A supplied ID must match that queue.

Response

Sidebar fields updated. qid is the document’s resolved queue ID.

messagestring
documentIdinteger
qidinteger
The document's resolved queue ID.
fieldslist of objects