API
Start free trialRaise a request

Update Book

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

Configure various properties of a Book.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

string
enum

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

Allowed:
string
enum

Describes how the Book was created. This feature is in beta. See our guides on OPTIMA and WIDGET for additional information.

Allowed:
boolean

true allows all users in your organization to see and upload Documents into this Book.

string

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

string

A free form field that can be used to associate a Book with some identity outside of Ocrolus.

Responses

Updated 2 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago