Rename, retime, pause or resume a schedule

Set is_active to false to pause and true to resume (resuming needs an eligible plan and clears the failure count).

patch/v1/schedules/{scheduleId}

Request

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

Path parameters

scheduleIdstring uuid required

Request body

namestring nullable
interval'hourly' | 'daily' | 'weekly'
change_thresholdnumber
notify_emailboolean
is_activeboolean

Response

Updated schedule

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.