---
title: "Update Book"
method: POST
path: "/v1/book/update"
tags: ["Book Commands"]
---

# Update Book

`POST /v1/book/update`

Configure various properties of a <<glossary:Book>>.

## Request body

- object
  - `book_uuid` string — The unique identifier of the <<glossary:Book>> you want to configure. Mutually exclusive with `pk`.
  - `pk` string — 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](https://docs.ocrolus.com/docs/ocrolus-lab) and [WIDGET](https://docs.ocrolus.com/docs/widget) for additional information.
  - `is_public` boolean — `true` allows all users in your organization to see and upload <<glossary:Document>>s into this <<glossary:Book>>.
  - `name` string — The <<glossary:Book>>'s new name. If not given, the name will be unchanged.
  - `xid` string — A free form field that can be used to associate a <<glossary:Book>> with some identity outside of Ocrolus.

## Response `200`

Success

- object
  - `status` integer — A numerical code that indicates the status of the request.
  - `response` object — An object received from the server that potentially contains data.
    - `name` string — The name of the <<glossary:Book>>.
    - `created` string — A timestamp of when the <<glossary:Book>> was created.
    - `created_ts` string — A timestamp of when the <<glossary:Book>> was created.
    - `pk` integer — The unique primary key of the <<glossary:Book>>
    - `uuid` string — The unique identifier of the <<glossary:Book>>.
    - `owner_email` string — The email of the user that created or currently owns the <<glossary:Book>>.
    - `is_public` boolean — Indicates if all users in your organization can see and upload <<glossary:Document>>s into this <<glossary:Book>>."
    - `xid` string — A free form field that can be used to associate a <<glossary:Book>> with some identity outside of Ocrolus.
    - `book_type` string — Determines what type of processing the <<glossary:Book>> will go through. Options include DEFAULT, OPTIMA, or WIDGET.
    - `id` integer — The <<glossary:PK>> of the <<glossary:Book>>
    - `book_context` object — An object containing additional context on the type of the processing the <<glossary:Book>> will go through.
      - `uuid` string — The unique identifier of the Book's context.
      - `book_uuid` string — The unique identifier of the Book's context.
      - `book_class` string — The processing type of the book. Can be either 'COMPLETE' or 'INSTANT'.
      - `created_ts` string — A timestamp of when the <<glossary:Book>> was created.
  - `message` string — A textual description that indicates details about this response's status.

## Other responses

- `400` — Client Errors

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)