book-scan

Run a book scan now

Sweeps the org's active households on the job queue under the saved schedule's configuration, or under config when sent. Answers 202 at once; the result lands at the scan's href and is announced with book.scan.completed. Every scanned household counts as active this month.

post/api/v1/book-scans

Request

  • Base URL: https://worthune.com
  • URL: https://worthune.com/api/v1/book-scans
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

Response

Filed and queued.

okunknown required
hrefstring required
notestring required

Changes

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