Snapshot | Website Screenshot API

Overview

Update Schedule

Updates an existing schedule by ID. Use this to change schedule metadata or schedule timing configuration.

Endpoint

PUThttps://snapshot-api.mindiqglobal.com/api/v1/schedules/{id}

Path Parameters

Name	Required	Type	Description
id	Yes	integer	Schedule ID.

Request Body

{
  "name": "Updated Name",
  "description": "Updated description",
  "schedule": {
    "type": "CRON",
    "cronExpression": "0 */30 * * * *"
  }
}

Request Body Parameters

Field	Required	Type	Description
name	No	string	Updated schedule name.
description	No	string	Updated schedule description.
schedule	No	object	Updated schedule timing configuration.
schedule.type	Conditional	enum	Required when schedule is provided. Possible values: ONCE, INTERVAL, CRON.
schedule.firstRunAt	Conditional	datetime	First run datetime in ISO-8601 format. Required for ONCE; optional for other types based on workflow.
schedule.intervalValue	Conditional	integer	Required when schedule.type is INTERVAL. Expected positive integer (for example, 1, 2, 12).
schedule.intervalUnit	Conditional	enum	Required when schedule.type is INTERVAL. Possible values: MINUTES, HOURS, DAYS, WEEKS, MONTHS.
schedule.cronExpression	Conditional	string	Required when schedule.type is CRON.

Success Response

{
  "id": 21,
  "name": "Updated Name",
  "description": "Updated description",
  "status": "ACTIVE",
  "schedule": {
    "type": "CRON",
    "firstRunAt": null,
    "intervalValue": null,
    "intervalUnit": null,
    "cronExpression": "0 */30 * * * *"
  },
  "nextRunAt": "2026-08-07T09:30:00Z",
  "lastRunAt": null,
  "items": [],
  "createdAt": "2026-08-06T10:00:00Z",
  "updatedAt": "2026-08-06T11:00:00Z"
}

Response Body Parameters

Name	Type	Description
id	integer	Schedule ID.
name	string	Updated schedule name.
description	string \| null	Updated schedule description.
status	enum	Schedule status, Possible values: ACTIVE, COMPLETED
schedule	object	Updated schedule timing configuration.
schedule.type	enum	Possible values: ONCE, INTERVAL, CRON.
schedule.firstRunAt	datetime \| null	First run datetime in ISO-8601 format.
schedule.intervalValue	integer \| null	Interval value for interval schedules.
schedule.intervalUnit	enum \| null	Possible values: MINUTES, HOURS, DAYS, WEEKS, MONTHS.
schedule.cronExpression	string \| null	Cron expression for cron schedules.
nextRunAt	datetime \| null	Next run datetime in ISO-8601 format.
lastRunAt	datetime \| null	Last run datetime in ISO-8601 format.
items	array	Current schedule items.
createdAt	datetime	Schedule creation datetime in ISO-8601 format.
updatedAt	datetime	Schedule update datetime in ISO-8601 format.