Skip to main content
PUT
/
v1
/
schedules
/
{scheduleId}
Update schedule
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Weekly Sales Report",
  "schedule": "0 9 * * MON",
  "timezone": "America/New_York",
  "format": "pdf",
  "destinationType": "email",
  "recipients": [
    "blob.ross@blobsrus.com"
  ],
  "subject": "Weekly Sales Dashboard",
  "paperFormat": "letter",
  "paperOrientation": "landscape"
}
'
{
  "success": true,
  "scheduledTaskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Updates the specified task. Changes to the schedule will be applied to future runs. Currently running jobs are not affected.
Only properties included in the request will be updated. Omitted properties will retain their current values.

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:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/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.