book-scan

Save the sweep configuration (and the nightly scan)

While enabled (the default), the whole book is scanned nightly at about 05:15 UTC; sandbox organizations are skipped at night and may run it on demand. A pinned profile must exist when saved. Every scanned household counts as active for the month.

put/api/v1/book-scans/schedule

Request

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

Request body

enabledboolean

Response

Saved.

okunknown required
notestring required

Changes

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