Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
scheduled_exports
Scheduled Exports

Update Scheduled Export

Update Scheduled Export

patch/scheduled_exports/{id}

Path parameters

idinteger required

Scheduled Export ID.

Response

The ScheduledExports object.

idinteger

Scheduled Export ID

namestring

Name for this scheduled export.

export_typestring

Export report type. Valid values: folder_size_audit, group_membership_audit, permission_audit, share_link_audit

report_namestring

Human-readable report name.

export_optionsobject

Report-specific options. permission_audit supports group_by with user or path.

user_idinteger

Site Admin user who receives the completed export e-mail.

disabledboolean

If true, this scheduled export will not run.

trigger'daily' | 'custom_schedule'

Schedule trigger type: daily or custom_schedule.

intervalstring

If trigger is daily, this specifies how often to run the scheduled export.

recurring_dayinteger

If trigger is daily, this selects the day number inside the chosen interval.

schedule_days_of_weekinteger[]

If trigger is custom_schedule, the 0-based weekdays used by the schedule.

schedule_times_of_daystring[]

Times of day in HH:MM format for schedule-driven exports.

schedule_time_zonestring

Time zone used by the scheduled export.

holiday_regionstring

Optional holiday region used by schedule-driven exports.

human_readable_schedulestring

Human-readable schedule description.

last_run_atstring date-time

Most recent scheduled run time.

last_export_idinteger

Most recent Export ID created by this schedule.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

{
  "id": 1,
  "name": "Monthly access review",
  "export_type": "permission_audit",
  "report_name": "Permission audit",
  "export_options": {
    "group_by": "user"
  },
  "user_id": 1,
  "disabled": true,
  "trigger": "daily",
  "interval": "month",
  "recurring_day": 1,
  "schedule_days_of_week": [
    1,
    3,
    5
  ],
  "schedule_times_of_day": [
    "06:30"
  ],
  "schedule_time_zone": "Eastern Time (US & Canada)",
  "holiday_region": "us",
  "human_readable_schedule": "Runs every month at 06:30 AM UTC TZ.",
  "last_run_at": "2000-01-01T01:00:00Z",
  "last_export_id": 1,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}