Update a report schedule

PATCH

/v2/reports/:reportId/schedules/:scheduleId

PATCH

/v2/reports/:reportId/schedules/:scheduleId

$ curl -X PATCH https://api.sigmacomputing.com/v2/reports/reportId/schedules/scheduleId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "scheduledNotificationId": "string",
3   "reportId": "string",
4   "schedule": {
5     "cronSpec": "string",
6     "timezone": "string"
7   },
8   "configV2": {
9     "title": "string",
10     "messageBody": "string",
11     "notificationAttachments": [
12       {
13         "formatOptions": {
14           "layout": "portrait",
15           "scaleFactor": 1.1,
16           "type": "PDF"
17         },
18         "workbookExportSource": {
19           "type": "report"
20         }
21       }
22     ],
23     "includeLink": true,
24     "runAsRecipient": true,
25     "attachmentSettings": {
26       "mergePdfAttachments": true,
27       "zipAttachments": true
28     },
29     "conditionOptions": {
30       "type": "always"
31     },
32     "alertConfig": {
33       "window": "alltime",
34       "volume": 1.1
35     },
36     "notificationName": "string",
37     "reportSettings": {
38       "filters": [
39         {
40           "id": "string",
41           "filterStr": "string"
42         }
43       ],
44       "variableValues": {}
45     },
46     "dynamicExportSettings": {
47       "variables": {}
48     },
49     "dynamicRecipientSettings": {
50       "sourceNodeId": "string",
51       "recipientColumnId": "string"
52     },
53     "rowLimit": 1.1,
54     "reportVariant": {
55       "tagId": "string"
56     },
57     "embedOpts": {
58       "embedId": "string",
59       "evalConnectionId": "string"
60     }
61   },
62   "isSuspended": true,
63   "ownerId": "string",
64   "lastUpdatedByUser": "string",
65   "disabledAt": "2024-01-15T09:30:00Z",
66   "disabledBy": "string",
67   "createdBy": "string",
68   "updatedBy": "string",
69   "createdAt": "2024-01-15T09:30:00Z",
70   "updatedAt": "2024-01-15T09:30:00Z"
71 }

This endpoint allows you to update an existing scheduled report export.

Usage notes

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

Usage scenarios

Audit schedules: Update schedules to ensure they are being exported at the correct times or to the correct recipients.

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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

reportIdstringRequired

scheduleIdstringRequired

Request

The request body.

targetlist of objectsOptional

One or more targets to send the report to.

scheduleobjectOptional

When to send the report 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.

reportIdstring

Unique identifier of the report.

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.