OCocrolus
Book Commands

Update Book

This API helps you configure properties of a <glossary: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.

post/v1/book/update

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/book/update
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Request body

book_uuidstring

The unique identifier of the <glossary:Book> you want to configure. Mutually exclusive with pk.

pkinteger

The <glossary:PK> of the <glossary:Book> you want to configure. Mutually exclusive with book_uuid.

book_class'COMPLETE' | 'INSTANT'

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.

is_publicboolean

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

namestring

The <glossary:Book>'s new name. If not given, the name will be unchanged.

xidstring

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.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

Example response

{
  "status": 200,
  "response": {
    "name": "Example Book",
    "created": "2023-07-31T15:59:51Z",
    "created_ts": "2023-07-31T15:59:51Z",
    "pk": 34101490,
    "uuid": "52dfdb53-6652-4d3a-a3db-fe864c6ff2fb",
    "owner_email": "email@address.com",
    "is_public": true,
    "book_type": "DEFAULT",
    "id": 34101490,
    "book_class": "INSTANT",
    "book_context": {
      "uuid": "7876239a-ff18-42f3-a6b8-66db5af2e26a",
      "book_uuid": "68a101e1-591c-4b87-acf3-ab8a55ceb746",
      "book_class": "INSTANT",
      "created_ts": "2023-07-31T15:59:51Z"
    }
  },
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.