Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Book Commands

Update Book

Configure various properties of a <glossary:Book>.

post/v1/book/update

Request body

book_uuidstring

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

pkstring

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 <glossary:Book> will go through. By default this value will be set to COMPLETE unless your organization is configured to have INSTANT as the default.

book_type'DEFAULT' | 'OPTIMA' | 'WIDGET'

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

is_publicboolean

true allows all users in your organization to see and upload <glossary:Document>s into this <glossary:Book>.

namestring

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

xidstring

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

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": "Test Book",
    "created": "2022-08-15T10:03:06Z",
    "created_ts": "2022-08-15T10:03:06Z",
    "pk": 10399,
    "uuid": "8dc88eed-2b6f-414a-82f2-a99bd181cf6e",
    "owner_email": "email@address.com",
    "xid": "ABC123",
    "book_type": "DEFAULT",
    "id": 10399
  },
  "message": "OK"
}