Update Book

post

https://api.ocrolus.com/v1/book/update

Configure properties of a Book, including its processing class, visibility, name, and external identifier.

To change a Book’s processing class such as Instant → Complete, set book_class in this request. Book class changes are forward-only. For allowed transitions, guardrails, errors, and webhook guidance, see the Book Upgrades.

To upgrade individual documents without changing the Book class, use the Upgrade a document or Upgrade a mixed document API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

book_uuid

string

The unique identifier of the Book you want to configure. Mutually exclusive with pk.

string

The PK of the Book you want to configure. Mutually exclusive with book_uuid.

book_class

string

enum

Determines what type of processing the Book will go through. By default this value is set to COMPLETE unless your organization is configured to have INSTANT as the default.

Updating book_class upgrades the Book's processing pipeline. Upgrades are forward-only (for example, INSTANT to COMPLETE). Downgrades are not allowed. See Book Upgrades for lifecycle rules, processing locks, and error handling.

Allowed:

book_type

string

enum

Describes how the Book was created. Use OPTIMA for Ocrolus lab and WIDGET for Books created via the Ocrolus Widget. Defaults to DEFAULT.

Allowed:

is_public

boolean

When true, all users in your organization can see and upload documents into this Book. Defaults to true.

name

string

The Book's new name. If not given, the name will be unchanged.

xid

string

A free-form field for associating this Book with an identity outside of Ocrolus, such as a loan ID in your own system. This value is returned as-is in the response.

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Success

400Client Errors

500Internal server error