VIviewpoints
Study Schedules

Create or update a study schedule

Creates a new schedule for the study if one doesn't exist, or updates the existing schedule. The study must belong to the authenticated user. Scheduled runs are outside the max_reruns_per_study allotment (the scheduler launches as the service account and pays the owner's credits), so a capped product may schedule. When enabled, next_scheduled_run is set to now plus the repeat interval. When disabled, next_scheduled_run is cleared.

put/v1/study-schedules/{study_id}

Request

  • Base URL
    https://api.viewpoints.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

study_idstring required

The UUID of the study to schedule

Request body

enabledboolean required
repeat_interval7 | 14 | 30 nullable

Response

OK

enabledboolean required
idstring required
next_scheduled_runstring date-time nullable
repeat_interval7 | 14 | 30 nullable
source_study_idstring required

Changes

No recorded changes to this operation across all 11 revisions of this API.