---
title: "Rename, retime, pause or resume a schedule"
method: PATCH
path: "/v1/schedules/{scheduleId}"
---

# Rename, retime, pause or resume a schedule

`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`

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

## Path parameters

- `scheduleId` string, uuid, required

## Request body

- object
  - `name` string, nullable
  - `interval` 'hourly' | 'daily' | 'weekly'
  - `change_threshold` number
  - `notify_email` boolean
  - `is_active` boolean

## Response `200`

Updated schedule

- Schedule
  - `id` string, uuid
  - `name` string, nullable
  - `url` string, uri
  - `interval` 'hourly' | 'daily' | 'weekly'
  - `format` 'png'
  - `options` object: Render options, same names as the batch endpoint.
  - `changeThreshold` number
  - `notifyEmail` boolean
  - `isActive` boolean
  - `pausedReason` 'user' | 'plan' | 'failures' | 'account' | 'null', nullable
  - `consecutiveFailures` integer
  - `lastError` string, nullable
  - `lastRunAt` string, date-time, nullable
  - `nextRunAt` string, date-time, nullable
  - `createdAt` string, date-time

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `403`: Scheduled captures are not available on this account
- `404`: Schedule not found

---

[API](https://skmtc.dev/snap-render/apis/snaprender-screenshot-api.md) · [All operations](https://skmtc.dev/snap-render/apis/snaprender-screenshot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/snap-render/apis/snaprender-screenshot-api/revisions/420ff88deeb2?raw)