Skip to main content
PUT
Update schedule

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

scheduleId
string<uuid>
required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard of a document.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

Body

application/json

Same properties as Create schedule. All properties are optional - only included properties will be updated.

Response

Schedule updated successfully

success
boolean

Indicates the request was successful.

scheduledTaskId
string<uuid>

The ID of the updated schedule.