---
title: "Updates a Schedule"
method: POST
path: "/v1/schedules/item/{schedule_id}"
tags: ["Schedules"]
---

# Updates a Schedule

`POST /v1/schedules/item/{schedule_id}`

Update schedule

## Path parameters

- `schedule_id` string, required

## Request body

- ScheduleDetails
  - `schedule_id` string — ID of the schedule
  - `name` string, required — Schedule Name
  - `category` 'ComplianceStandard' | 'Policy' | 'PolicyRemediation' | 'Reports' | 'Script' | 'Template', required — Category of the schedule.
  - `source` 'Report' | 'ScheduleRecommendation' — Source of the schedule creation
  - `description` string — Description of the schedule
  - `recurrence` 'Once' | 'Minutes' | 'Hours' | 'Daily' | 'Weekly' | 'Monthly' | 'Annually' — Re-occurrence of the schedule
  - `next_run` string, date-time — When will the schedule run for the next time
  - `last_run` string, date-time — When the last schedule triggered
  - `end_run` string, date-time — Upto when the schedule should run
  - `schedule` SchedulingDetails, required
    - `month` string, required — Month when the given category is scheduled to run. Allowed values: 1-12 or JAN-DEC
    - `time` SchedulingTimeDetails, required
      - `seconds` string, required — Scheduled at which second, allowed values: 0-59
      - `minute` string, required — Scheduled at which minute, allowed values: 0-59
      - `hour` string, required — Scheduled at which hour, allowed values: 0-23
    - `dayofmonth` SchedulingDayDetails
      - `day` string, required — At which day of that month or week the given category is scheduled to run.Allowed values: 1-31, for month and 0-7 or SUN-SAT for week. Both 0 and 7 represent Sunday.
    - `weekday` SchedulingDayDetails
      - `day` string, required — At which day of that month or week the given category is scheduled to run.Allowed values: 1-31, for month and 0-7 or SUN-SAT for week. Both 0 and 7 represent Sunday.
    - `year` string — Year when the given category is scheduled to run. Example:'2024-2099'
  - `timezone` string — Timezone of the schedule
  - `resource` string, required — ID of the resource which is scheduled. Can be retrieved using the respective List API
  - `resource_args` string — Input Parameters for the resource that is scheduled which is a JSON string
  - `execution_params` ScheduleExecutionParameterBase[] — Execution parameters for the schedule.
    - `type` string, required — Concrete type used for polymorphic deserialization (discriminator)
  - `notification_configuration` ScheduleExecutionNotificationConfiguration
    - `email_recipients` string[] — List of Email IDs
    - `webhooks` ScheduleExecutionNotificationWebHookForStandardType[] — Webhooks to trigger notifications
      - `webhook_id` string — Webhook ID to trigger notification
      - `__type` string, required — Concrete type used for polymorphic deserialization (discriminator)
  - `is_active` boolean — Flag to represent whether the schedule is active or not.
  - `is_system_schedule` boolean — Flag to represent whether the schedule is system scheduled or not.
  - `tenant_id` string — Tenant owning the schedule.
  - `created_at` string, date-time — When the schedule is created
  - `created_by` string — Who has created the schedule
  - `updated_at` string, date-time — When the schedule is updated
  - `updated_by` string — Who has updated the schedule
  - `background_job` RecordIdentity
    - `sysId` string — Unique Identifier of the tracked item
    - `lastUpdate` string, date-time — Last update of the tracked item
    - `table` string — Context of the tracked item

## Response `200`

Success

- ScheduleDetails
  - `schedule_id` string — ID of the schedule
  - `name` string, required — Schedule Name
  - `category` 'ComplianceStandard' | 'Policy' | 'PolicyRemediation' | 'Reports' | 'Script' | 'Template', required — Category of the schedule.
  - `source` 'Report' | 'ScheduleRecommendation' — Source of the schedule creation
  - `description` string — Description of the schedule
  - `recurrence` 'Once' | 'Minutes' | 'Hours' | 'Daily' | 'Weekly' | 'Monthly' | 'Annually' — Re-occurrence of the schedule
  - `next_run` string, date-time — When will the schedule run for the next time
  - `last_run` string, date-time — When the last schedule triggered
  - `end_run` string, date-time — Upto when the schedule should run
  - `schedule` SchedulingDetails, required
    - `month` string, required — Month when the given category is scheduled to run. Allowed values: 1-12 or JAN-DEC
    - `time` SchedulingTimeDetails, required
      - `seconds` string, required — Scheduled at which second, allowed values: 0-59
      - `minute` string, required — Scheduled at which minute, allowed values: 0-59
      - `hour` string, required — Scheduled at which hour, allowed values: 0-23
    - `dayofmonth` SchedulingDayDetails
      - `day` string, required — At which day of that month or week the given category is scheduled to run.Allowed values: 1-31, for month and 0-7 or SUN-SAT for week. Both 0 and 7 represent Sunday.
    - `weekday` SchedulingDayDetails
      - `day` string, required — At which day of that month or week the given category is scheduled to run.Allowed values: 1-31, for month and 0-7 or SUN-SAT for week. Both 0 and 7 represent Sunday.
    - `year` string — Year when the given category is scheduled to run. Example:'2024-2099'
  - `timezone` string — Timezone of the schedule
  - `resource` string, required — ID of the resource which is scheduled. Can be retrieved using the respective List API
  - `resource_args` string — Input Parameters for the resource that is scheduled which is a JSON string
  - `execution_params` ScheduleExecutionParameterBase[] — Execution parameters for the schedule.
    - `type` string, required — Concrete type used for polymorphic deserialization (discriminator)
  - `notification_configuration` ScheduleExecutionNotificationConfiguration
    - `email_recipients` string[] — List of Email IDs
    - `webhooks` ScheduleExecutionNotificationWebHookForStandardType[] — Webhooks to trigger notifications
      - `webhook_id` string — Webhook ID to trigger notification
      - `__type` string, required — Concrete type used for polymorphic deserialization (discriminator)
  - `is_active` boolean — Flag to represent whether the schedule is active or not.
  - `is_system_schedule` boolean — Flag to represent whether the schedule is system scheduled or not.
  - `tenant_id` string — Tenant owning the schedule.
  - `created_at` string, date-time — When the schedule is created
  - `created_by` string — Who has created the schedule
  - `updated_at` string, date-time — When the schedule is updated
  - `updated_by` string — Who has updated the schedule
  - `background_job` RecordIdentity
    - `sysId` string — Unique Identifier of the tracked item
    - `lastUpdate` string, date-time — Last update of the tracked item
    - `table` string — Context of the tracked item

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/corestack/apis/corestack-external-api.md) · [All operations](https://skmtc.dev/corestack/apis/corestack-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/corestack/corestack-external-api/revisions/bf2cdf20826d/schema)