OCocrolus
Book Commands

Delete Book

Delete a <glossary:Book> that you no longer need.

🚧 No turning back! Deleting a <glossary:Book> also deletes the <glossary:Document>s contained within. This action is not reversible, meaning that you can't recover deleted <glossary:Document>s and <glossary:Book>s. Make sure you're ready!

post/v1/book/remove

Request

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

Request body

book_idstring

The <glossary:PK> of the <glossary:Book> you'd like to delete. Mutually exclusive with book_uuid.

book_uuidstring

The unique identifier of the <glossary:Book> you'd like to delete. Mutually exclusive with book_id.

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.

responseobject

An object received from the server that potentially contains data.

Example response

{
  "status": 200,
  "message": "OK"
}

Changes

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