Update Recurrence

put

https://example.com/test/api/web/schedules/{ScheduleId}/recurrences/{RecurrenceId}

api/web/schedules/{ScheduleId}/recurrences/{RecurrenceId}

Updates an existing recurrence on the schedule based on the supplied model.

Path Params

ScheduleId

int32

required

≥ 1

The ID of the schedule (ScheduleId >= 1).

RecurrenceId

int32

required

≥ 1

The ID of the recurrence to update (RecurrenceId >= 1).

Body Params

The recurrence model with updated data.

Recurrence defines when the schedule should be executed

Day

string

enum

required

Month

int32

required

0 to 12

The month when the schedule should be executed. A value of 0 "zero" means
all months.

Last

boolean

required

Last is a modifier to the general recurrence that inverts the meaning of the Date field.
"False" means Run on the last business day of every month.
"True" means Run on the second to last business day of every month.

Enabled

boolean

required

Show if the recurrence is active

FromDate

date-time

required

The first date the recurrence is active.
///

HolidayBehavior

string

enum

required

Allowed:

Date

int32

required

0 to 31

The date when the schedule should be executed. A value of 0 "zero" means
all months.

StartTime

string | null

The time when execution should start.
Set in the format '12:34'

ToDate

date-time

required

The last date the recurrence is active.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language

Loading…

Response

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

application/json

200OK