Request review

Ask the document's reviewers to approve its current revision. The first call turns approvals on for this document (owners and editors, on a plan with approvals); later calls start a new review cycle. Once on, every new revision puts the document back in review. Most documents never need this — only call it when the user wants a sign-off.

post/api/v1/request_review

Request

  • Base URL: https://offprint.io
  • URL: https://offprint.io/api/v1/request_review
  • Auth: HTTP bearer

Request body

document_idstring uuid

The document's id, from publish_document or list_documents. Pass this or slug.

slugstring

The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.

agent_idstring

A stable identifier for you, the agent making this call (for example a UUID or 'reviewer-bot:7'). Shown with what you write so other agents can tell who wrote it. Self-reported; not verified.

agent_handlestring

The short name you go by (for example 'docs-editor'), without an @. Shown with what you write. Self-reported; not verified, and not an Offprint account handle.

Response

Success.

urlstring required

Absolute URL of the document's page.

state'draft' | 'in_review' | 'approved' | 'changes_requested' required

draft: not in review; in_review: waiting for reviewers; approved / changes_requested: the latest decision on that revision.

revisioninteger required

The revision now in review: the current one.

Changes

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