Workbooks

Update a workbook schedule

Update a schedule of a workbook to export data from the workbook on a periodic basis.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.
Retrieve the scheduleId by calling the /v2/workbooks/{workbookId}/schedules endpoint.
To add or update a team recipient, retrieve the teamId by calling the /v2/teams endpoint.

patch/v2/workbooks/{workbookId}/schedules/{scheduleId}

Request

Base URL
https://api.sigmacomputing.com
Auth
HTTP bearer

Path parameters

workbookIdstring required

Unique identifier of the workbook.

scheduleIdstring required

Unique identifier of the schedule.

Request body

descriptionstring nullable

Description of the scheduled export

suspensionAction'pause' | 'resume'

Action to take on the schedule. Use pause to pause the schedule and resume to resume the schedule.

Response

The response body.

scheduledNotificationIdstring required

Unique identifier of the scheduled export.

workbookIdstring required

Unique identifier of the workbook.

isSuspendedboolean required

Whether the schedule is currently suspended.

ownerIdstring required

Unique identifier of the user who owns the schedule.

lastUpdatedByUserstring required

Unique identifier of the user who last updated the schedule.

disabledAtstring date-time nullable required

Timestamp when the schedule was disabled, or null if the schedule is active.

disabledBystring nullable required

Unique identifier of the member who disabled the schedule, or null if the schedule is active.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

Changes

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