Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Encore

Accept Book copy jobs

This API enables a recipient organization to accept an incoming <glossary:Book> copy request. Once accepted, Ocrolus begins copying the Book and its associated documents to the recipient organization. The recipient may optionally change the Book name when accepting a Book copy request. Alternatively, the recipient can rename the Book after it has been accepted. A book.copy.request_accepted webhook event is then triggered and sent to the sender organization.

📘 Note

  • This API is intended for small and medium business (SMB) funders using the Book copy feature.
  • A Book copy job can be accepted only when its status is AWAITING_RECIPIENT or REJECTED.
post/v1/book/copy-jobs/{job_id}/accept

Path parameters

job_idstring uuid required

UUID of the Book copy job to accept.

Request body

book_namestring

Custom name for the copied Book. If not provided, the Book will be named using the sender's original Book name followed by a timestamp.

📘 Book name sanitization

  • The provided book_name is automatically cleaned.
  • The Book name must be between 4 and 255 characters long.
  • Leading and trailing whitespace is removed.
  • Non-ASCII characters such as emojis or special Unicode characters are removed.
  • If the resulting name is empty after sanitization, a 400 error is returned.

Response

The Book copy job was successfully accepted.

messageobject

The Book copy job was successfully accepted.

📘 When a Book is successfully accepted, the API returns a 204 No Content response with no response body. Since no payload is returned, an example response is not shown.