Updates a Schedule

post

https://v1/schedules/item/{schedule_id}

Update schedule

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

schedule_id

string

required

Specify the schedule Id to update the schedule data

Body Params

schedule_id

string

ID of the schedule

name

string

required

Schedule Name

category

string

enum

required

Category of the schedule.

Allowed:

source

string

enum

Source of the schedule creation

Allowed:

description

string

Description of the schedule

recurrence

string

enum

Re-occurrence of the schedule

Allowed:

next_run

date-time

When will the schedule run for the next time

last_run

date-time

When the last schedule triggered

end_run

date-time

Upto when the schedule should run

schedule

object

required

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

array of objects

Execution parameters for the schedule.

execution_params

notification_configuration

object

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

date-time

When the schedule is created

created_by

string

Who has created the schedule

updated_at

date-time

When the schedule is updated

updated_by

string

Who has updated the schedule

background_job

object

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

500Internal Server Error