Capture now

Makes the schedule due immediately; the capture runs within a minute.

post/v1/schedules/{scheduleId}/run

Request

  • Base URL: https://app.snap-render.com
  • URL: https://app.snap-render.com/v1/schedules/{scheduleId}/run
  • Auth: API key in header X-API-Key

Path parameters

scheduleIdstring uuid required

Response

Capture queued

idstring uuid
namestring nullable
urlstring uri
interval'hourly' | 'daily' | 'weekly'
format'png'
optionsobject

Render options, same names as the batch endpoint.

changeThresholdnumber
notifyEmailboolean
isActiveboolean
pausedReason'user' | 'plan' | 'failures' | 'account' | 'null' nullable
consecutiveFailuresinteger
lastErrorstring nullable
lastRunAtstring date-time nullable
nextRunAtstring date-time nullable
createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.