--- title: "Update a report schedule" method: PATCH path: "/v2/reports/{reportId}/schedules/{scheduleId}" tags: ["Reports"] --- # Update a report schedule `PATCH /v2/reports/{reportId}/schedules/{scheduleId}` ## Request - Base URL: `https://api.sigmacomputing.com` - URL: `https://api.sigmacomputing.com/v2/reports/{reportId}/schedules/{scheduleId}` - Auth: HTTP bearer This endpoint allows you to update an existing scheduled report export. ### Usage notes - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. - Retrieve the **scheduleId** by calling the [/v2/reports/{reportId}/schedules](https://help.sigmacomputing.com/reference/list-report-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. ### Usage scenarios - **Audit schedules**: Update schedules to ensure they are being exported at the correct times or to the correct recipients. ## Path parameters - `reportId` string, required - `scheduleId` string, required ## Request body - object - `target` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaTargetItems[]: One or more targets to send the report to. - `teamId` string: Unique identifier of the team to export to - `email` string: Email address to export to - `ccEmail` string: Email address to add as a Cc recipient - `bccEmail` string: Email address to add as a Bcc recipient - `ccTeamId` string: Unique identifier of the team to add as a Cc recipient - `bccTeamId` string: Unique identifier of the team to add as a Bcc recipient - `slackConversationId` string: Slack channel ID or member ID to export to - `googleSpreadsheetUrl` string: URL of the Google Sheet to export to - `googleDriveFolderUrl` string: URL of the Google Drive folder to export to - `webhookUrl` string: URL of the webhook endpoint to export to - `schedule` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSchedule: When to send the report export. - `cronSpec` string: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - `timezone` string: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. - `configV2` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2: Configuration settings for the export schedule. - `title` string: Title of the message - `messageBody` string: Body of the message - `exportAttachments` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems[]: Attachments to include in the export. Reports only support PDF. - `formatOptions` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions, required: Export format options. Reports only support PDF. - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - `scaleFactor` number, double - `exportName` string: Name of the scheduled export - `includeLink` boolean: Include a link to the exported report - `runAsRecipient` boolean: Run the export queries as the recipient - `attachmentSettings` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings: Export attachment settings - `mergeAttachments` boolean: Combines multiple PDF attachments into a single file - `zipAttachments` boolean: Send attachments as a .zip file - `reportVariant` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ReportVariant: Report variant - `tagId` string: Version tag to export - `conditionOptions` union: Export condition options - V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0: Always send the export - `type` 'always', required - V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1: Send the export based on a condition - `type` 'workbook', required - `condition` union, required - V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0: If there's no data - `type` 'isEmpty', required: Type of condition - `elementId` string, required: ID of the element - V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1: If there's data - `type` 'isNotEmpty', required: Type of condition - `elementId` string, required: ID of the element - V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2: If a condition is met - `type` 'column', required: Type of condition - `elementId` string, required: ID of the element - `columnId` string, required: ID of the column - `op` 'Equals' | 'GreaterThan' | 'GreaterThanEq' | 'LessThan' | 'LessThanEq' | 'NotEquals' | 'IsNull' | 'IsNotNull' | 'Contains' | 'StartsWith' | 'EndsWith', required: Operator - `mode` 'any' | 'all', required: Kind of condition evaluation - `value` union: Column value - … - `reportSettings` V2ReportsReportIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ReportSettings: Report settings - `controlValues` object: This object maps control IDs to the values that they should have when exporting the workbook. - `description` string, 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 `200` The response body. - ReportsUpdateReportScheduleResponse200 - `scheduledNotificationId` string, required: Unique identifier of the scheduled export. - `reportId` string, required: Unique identifier of the report. - `schedule` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaSchedule, required - `cronSpec` string, required: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - `timezone` string, required: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. - `configV2` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2, required - `title` string, required - `messageBody` string, required - `notificationAttachments` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems[], required - `formatOptions` union, required - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0 - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - `scaleFactor` number, double - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1 - `type` 'NONE', required - `workbookExportSource` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource - `type` 'report', required - `includeLink` boolean - `runAsRecipient` boolean - `attachmentSettings` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings - `mergePdfAttachments` boolean - `zipAttachments` boolean - `conditionOptions` union - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0 - `type` 'always', required - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1 - `type` 'workbook', required - `conditions` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems[], required - union - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2 - `type` 'worksheet', required - `conditions` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems[], required - union - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3 - `type` 'dashboard', required - `conditions` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems[], required - union - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1 - … - V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2 - … - `alertConfig` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfig - `window` 'alltime' | 'daily' | 'weekly' | 'always', required - `volume` number, double, nullable - `notificationName` string - `reportSettings` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ReportSettings - `filters` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ReportSettingsFiltersItems[] - `id` string, required - `filterStr` string, required - `variableValues` union - DashVariables0 - `type` 'boolean', required - `value` boolean, nullable, required - DashVariables1 - `type` 'number', required - `value` number, double, nullable, required - DashVariables2 - `type` 'text', required - `value` string, nullable, required - DashVariables3 - `type` 'date', required - `value` union, required - DashVariablesOneOf3Value0 - … - DashVariablesOneOf3Value1 - … - DashVariables4 - `type` 'number-list', required - `value` number[], required - DashVariables5 - `type` 'text-list', required - `value` string[], required - DashVariables6 - `type` 'date-list', required - `value` number[], required - DashVariables7 - `type` 'boolean-list', required - `value` DashVariablesOneOf7Value, required - `true` boolean, required - `false` boolean, required - `null` boolean - DashVariables8 - `type` 'date-range', required - `min` union, required - DashVariablesOneOf8Min0 - … - DashVariablesOneOf8Min1 - … - `max` union, required - DashVariablesOneOf8Max0 - … - DashVariablesOneOf8Max1 - … - DashVariables9 - `type` 'number-range', required - `min` number, double, nullable, required - `max` number, double, nullable, required - DashVariables10 - `type` 'date-null', required - DashVariables11 - `type` 'number-null', required - DashVariables12 - `type` 'text-null', required - DashVariables13 - `type` 'boolean-null', required - DashVariables14 - `type` 'hierarchical-list', required - `value` string[], required - DashVariables15 - `type` 'file', required - `value` DashVariablesOneOf15Value, required - `id` string, required - `name` string, required - `size` number, double, required - `type` string, required - `downloadUrl` string, required - DashVariables16 - `type` 'file-null', required - DashVariables17 - `type` 'file-list', required - `value` DashVariablesOneOf17ValueItems[], required - `id` string, required - `name` string, required - `size` number, double, required - `type` string, required - `downloadUrl` string, required - `dynamicExportSettings` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings - `variables` object - `dynamicRecipientSettings` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings - `sourceNodeId` string, required - `recipientColumnId` string, required - `rowLimit` number, double - `reportVariant` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ReportVariant - `tagId` string - `embedOpts` V2ReportsReportIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2EmbedOpts - `embedId` string - `evalConnectionId` string - `isSuspended` boolean, required: Whether the schedule is currently suspended. - `ownerId` string, required: Unique identifier of the user who owns the schedule. - `lastUpdatedByUser` string, required: Unique identifier of the user who last updated the schedule. - `disabledAt` string, date-time, nullable, required: Timestamp when the schedule was disabled, or null if the schedule is active. - `disabledBy` string, nullable, required: Unique identifier of the member who disabled the schedule, or null if the schedule is active. - `createdBy` string, required: The identifier of the user who created this object. - `updatedBy` string, required: The identifier of the user or process that last updated this object. - `createdAt` string, date-time, required: When the object was created. - `updatedAt` string, date-time, required: When the object was last updated. --- [API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)