Skip to content
v3 API/
/
Update specific Scheduled...

Update specific Scheduled Export

Request

PUT /v3/exports/scheduled/{scheduledExportId}
Security
API_Key
Path
scheduledExportIdinteger, (int64)required
Bodyapplication/jsonrequired

Scheduled Export definition

namestringrequired
exportedItemTypestringrequired
Value:"saved_report"
exportedItemIdinteger, (int64)required
exportFileFormatstringrequired
Enum:"csv""tsv""xlsx"
exportEmailConfigobjectrequired

Configuration for the email sent when export completes.

emailsArray of strings

List of email addresses that will receive export email. If empty, no emails will be sent. If omitted, emails will not be changed (update only).

scheduleobjectrequired

When and how often Scheduled Export will be run.

PUT
/v3/exports/scheduled/{scheduledExportId}
curl -i -X PUT \
  'https://api.observepoint.com/v3/exports/scheduled/{scheduledExportId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "exportedItemType": "saved_report",
    "exportedItemId": 0,
    "exportFileFormat": "csv",
    "exportEmailConfig": {
      "addExportFileAttachment": true,
      "customMessage": "string",
      "reportLinkType": "public_link",
      "suppressEmailWhenNoData": false
    },
    "emails": [
      "user@example.com"
    ],
    "schedule": {
      "dtStart": "2025-03-14T12:00:00",
      "recurrenceRule": "WKST=SU;FREQ=DAILY;INTERVAL=1",
      "tzId": "America/New_York",
      "isPaused": true,
      "exceptions": [
        "2025-03-14T12:00:00"
      ]
    }
  }'

Responses

Updated Scheduled Export

Bodyapplication/json
namestringrequired
exportedItemTypestringrequired
Value:"saved_report"
exportedItemIdinteger, (int64)required
exportFileFormatstringrequired
Enum:"csv""tsv""xlsx"
exportEmailConfigobjectrequired

Configuration for the email sent when export completes.

emailsArray of strings

List of email addresses that will receive export email. If empty, no emails will be sent. If omitted, emails will not be changed (update only).

idinteger, (int64)required
createdAtstring, (date-time)

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example:"2016-08-18T17:33:00Z"
updatedAtstring, (date-time)

Date-time in RFC3339 profile ISO 8601 format with the following additional restrictions:

  1. An uppercase T must separate the date and time portions.
  2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in AWS Step Functions - Choice Rules

Example:"2016-08-18T17:33:00Z"
ownerobject
scheduleobjectrequired

When and how often Scheduled Export will be run.

exportedItemNamestringrequired
isEditablebooleanrequired
Response
{
  "name": "string",
  "exportedItemType": "saved_report",
  "exportedItemId": 0,
  "exportFileFormat": "csv",
  "exportEmailConfig": {
    "addExportFileAttachment": true,
    "customMessage": "string",
    "reportLinkType": "public_link",
    "suppressEmailWhenNoData": false
  },
  "emails": [
    "user@example.com"
  ],
  "id": 0,
  "createdAt": "2016-08-18T17:33:00Z",
  "updatedAt": "2016-08-18T17:33:00Z",
  "owner": {
    "id": 123,
    "userName": "string"
  },
  "schedule": {
    "dtStart": "2025-03-14T12:00:00",
    "recurrenceRule": "WKST=SU;FREQ=DAILY;INTERVAL=1",
    "tzId": "America/New_York",
    "isPaused": true,
    "exceptions": [ … ],
    "description": "Every day",
    "presetType": "DAILY",
    "nextExportAt": "2016-08-18T17:33:00Z"
  },
  "exportedItemName": "string",
  "isEditable": true
}