Schedules API

List, create, and delete scheduled deliveries under /api/schedules.

The schedules endpoints manage recurring email deliveries of charts and dashboards. Listing needs the read scope; creating and deleting need write.

#List schedules

GET /api/schedules — return the scheduled deliveries the account can read.

#Create a schedule

POST /api/schedules — schedule a recurring delivery. Requires the write scope.

curl https://flax-analytics.com/api/schedules \
  -H "Authorization: Bearer flax_pat_..." \
  -H "Content-Type: application/json" \
  -d '{
    "resourceType": "dashboard",
    "resourceId": "dsh_123",
    "cron": "0 8 * * 1",
    "recipients": ["team@example.com"]
  }'

#Get, update, and delete a schedule

• GET /api/schedules/{scheduleId} — fetch one schedule (its cadence, channel, resources, and next run).
• PUT /api/schedules/{scheduleId} — replace its fields and resource set (write).
• DELETE /api/schedules/{scheduleId} — remove it (write). Returns 204.

#Run a schedule now

POST /api/schedules/{scheduleId}/run — fire the delivery immediately (a manual test send) without changing its cadence or next run. Requires the write scope, and the owner or an org admin / team lead for a scoped delivery. Deliverable resources are dashboards, charts, and datasets.

#Related

• Scheduled deliveries