Create Scheduled Report

POST 
/api/reporting/inventory-planning/schedules

Creates a new scheduled inventory planning report for the authenticated user.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token

Required fields:

• name: string (max 255)
• frequency: daily | weekly | monthly
• time: HH:MM (24h format)
• timezone: valid timezone string
• format: csv | xlsx
• recipients: array of emails (min 1)

Conditional required:

• day_of_week: integer 0-6 (required when frequency=weekly)
• day_of_month: integer 1-28 (required when frequency=monthly)

Optional:

• filters: object of filter values
• columns: array of column names

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

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.

429

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.