Sigma REST APIWorkbooksexport schedules

Update a workbook schedule

View as MarkdownOpen in Claude
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](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint. - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
scheduleIdstringRequired

Request

The request body.
targetlist of objectsOptional
One or more targets to send the workbook to.
scheduleobjectOptional
When to send the workbook export.
configV2objectOptional
Configuration settings for the export schedule.
descriptionstring or nullOptional
Description of the scheduled export
suspensionActionenumOptional

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

Allowed values:

Response

The response body.
scheduledNotificationIdstring
Unique identifier of the scheduled export.
workbookIdstring
Unique identifier of the workbook.
scheduleobject
configV2object
isSuspendedboolean
Whether the schedule is currently suspended.
ownerIdstring
Unique identifier of the user who owns the schedule.
lastUpdatedByUserstring
Unique identifier of the user who last updated the schedule.
disabledAtdatetime or null
Timestamp when the schedule was disabled, or null if the schedule is active.
disabledBystring or null
Unique identifier of the member who disabled the schedule, or null if the schedule is active.
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.