Add Schedule Items API

Overview

Add Schedule Items

The Snapshot Add Schedule Items API lets you add one or more website screenshot targets to an existing screenshot schedule. Each schedule item can define its target URL and capture settings, including viewport dimensions, full-page screenshots, image format, quality, delays, page loading conditions, CSS selectors, element capture, custom User-Agent and language settings, and optional HTML or text extraction. Use this endpoint when you need to expand an existing scheduled screenshot workflow with additional pages or websites without creating a new schedule.

Endpoint

POSThttps://snapshot-api.mindiqglobal.com/api/v1/schedules/{scheduleId}/items

Path Parameters

Name	Required	Type	Description
scheduleId	Yes	integer	Schedule ID.

Request Body

[
  {
    "url": "https://example.com/pricing",
    "width": 1440,
    "height": 900,
    "fullPage": true,
    "format": "png",
    "responseType": "json",
    "quality": 100,
    "delay": 0,
    "waitUntil": "page_loaded",
    "extractHtml": false,
    "extractText": false
  }
]

Request Body Parameters

Field	Required	Type	Description
[]	Yes	array	Array of schedule items to add.
[].url	Yes	string	Target URL (http:// or https://).
[].width	No	integer	Viewport width. Expected positive integer (for example, 1280, 1920).
[].height	No	integer	Viewport height. Expected positive integer (for example, 720, 1080).
[].fullPage	No	boolean	Capture full page. Possible values: true, false. Cannot be combined with crop or element.
[].format	No	enum	Image format. Possible values: png, jpeg.
[].responseType	No	enum	Scheduled captures support json only.
[].quality	No	integer	JPEG quality. Allowed range: 0-100.
[].delay	No	number	Capture delay in seconds. Allowed range: 0-10.
[].waitUntil	No	enum	dom_loaded, page_loaded, network_idle.
[].waitUntilTimeout	No	number	Allowed range: 1-30 seconds.
[].waitFor	No	string	CSS selector to wait for before capture (max wait 15s).
[].crop	No	string	Crop rectangle left,top,width,height. Cannot be combined with fullPage or element.
[].element	No	string	Capture first matching element selector. Cannot be combined with fullPage or crop.
[].thumbnailWidth	No	integer	Positive integer. Preserves aspect ratio.
[].userAgent	No	string	Custom user-agent.
[].acceptLanguage	No	string	Custom accept-language.
[].extractHtml	No	boolean	Default false. Only with responseType=json.
[].extractText	No	boolean	Default false. Only with responseType=json.

Success Response

[
  {
    "id": 45,
    "url": "https://example.com/pricing",
    "width": 1440,
    "height": 900,
    "fullPage": true,
    "format": "png",
    "responseType": "json",
    "quality": 100,
    "delay": 0,
    "waitUntil": "page_loaded",
    "waitUntilTimeout": 15,
    "waitFor": null,
    "crop": null,
    "element": null,
    "thumbnailWidth": null,
    "userAgent": null,
    "acceptLanguage": null,
    "extractHtml": false,
    "extractText": false,
    "createdAt": "2026-08-06T12:00:00Z",
    "updatedAt": "2026-08-06T12:00:00Z"
  }
]

Response Body Parameters

Name	Type	Description
[]	array	Added schedule items.
[].id	integer	Schedule item ID.
[].url	string	Target URL.
[].width	integer \| null	Viewport width.
[].height	integer \| null	Viewport height.
[].fullPage	boolean	Full page flag. Possible values: true, false.
[].format	enum	Possible values: png, jpeg.
[].responseType	enum	Scheduled captures use json.
[].quality	integer \| null	JPEG quality (0-100).
[].delay	number \| null	Capture delay in seconds.
[].waitUntil	enum \| null	dom_loaded, page_loaded, network_idle.
[].waitUntilTimeout	number \| null	wait_until timeout in seconds.
[].waitFor	string \| null	CSS selector wait target.
[].crop	string \| null	Crop rectangle left,top,width,height.
[].element	string \| null	Element selector target.
[].thumbnailWidth	integer \| null	Thumbnail width.
[].userAgent	string \| null	Custom user-agent.
[].acceptLanguage	string \| null	Custom accept-language.
[].extractHtml	boolean	Extract HTML enabled state.
[].extractText	boolean	Extract text enabled state.
[].createdAt	datetime	Item creation datetime in ISO-8601 format.
[].updatedAt	datetime	Item update datetime in ISO-8601 format.