Update schedule

put

https://platform-reporting.vertexcloud.com/api/v1/schedules/{scheduleId}

Update an existing schedule. All updatable fields are replaced with the values provided in the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

scheduleId

uuid

required

UUID of the schedule

Body Params

Payload for updating an existing schedule. All updatable fields are replaced with the values provided.

name

string

required

length between 1 and 64

Human-readable name of the schedule

description

string | null

Optional description of the schedule

enabled

boolean

Defaults to true

Indicates whether the schedule is enabled

scheduleType

string

enum

required

Schedule type

Allowed:

frequency

string

enum

Recurrence frequency for a schedule

Allowed:

endDate

date | null

Last date on which the schedule can run (inclusive). null means the schedule does not have a fixed end date

dayOfWeek

string | null

enum

Day of the week for weekly recurrence

Allowed:

dayOfMonth

int32 | null

1 to 31

Day of month on which the schedule runs when using MONTHLY, QUARTERLY, or ANNUAL frequency

monthOfYear

int32 | null

1 to 12

Month of year (1-12) on which the schedule runs when using QUARTERLY or ANNUAL frequency

timeOfDay

string

required

Time of day at which the schedule triggers, in HH:mm format

Responses

200Schedule updated

400Invalid schedule payload

401Unauthorized

403Forbidden

404Schedule not found

409Schedule with the same parameters already exists

500Internal server error