Update Schedule
PUT/api/inventory-forecasting/schedules/:schedule
Update a forecast schedule. All fields are optional; merges with existing data.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
PO settings (all optional):
- auto_create_po (boolean), po_status (draft|approved|approved_sent), separate_po_by_brand (boolean), auto_receive_po (boolean). auto_receive_po is ignored when po_status is draft.
misfire_policy (optional): what to do when a scheduled run was missed, one of run_once, skip, run_within_deadline. starting_deadline_minutes (optional, integer 1-1440): how late a missed run may still start under run_within_deadline.
Switching a schedule to Approved / Approved & Sent purchase orders, or turning PO creation on for one that already uses those statuses, needs purchase_orders.approve (or an approval policy covering forecast purchase orders) and is otherwise refused with 403. Edits that leave an existing schedule's PO settings unchanged are not affected.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.