Create Schedule

POST 
/api/v2/custom-reports/:id/schedules

Create a new schedule.

Required scope: reports:write

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

Required fields:

• frequency (string): daily, weekly, or monthly
• time_of_day (string): H:i or H:i:s
• recipients (array of valid emails, min 1)

Optional fields:

• day_of_week (0-6) when frequency is weekly
• day_of_month (1-31) when frequency is monthly
• timezone (string, default UTC)
• export_format (csv, xlsx, pdf, default csv)
• is_active (boolean, default true)

Returns 201 with the schedule resource. Returns 403 if the caller is not the report owner.

Request

Responses

200

Successful response

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.