RecurrencePattern

Specifies the detailed pattern for event recurrence. Use this to define complex scheduling rules such as "every 2nd Tuesday of the month" or "every 3 months on the 15th".

Frequency

Defines how often the pattern repeats. This is the base unit for the recurrence schedule and works in conjunction with the Interval field to determine the exact repetition sequence.

Type: String

Valid Values: WEEKLY | MONTHLY | YEARLY

Required: Yes

Interval

Specifies the number of frequency units between each occurrence. Must be a positive integer.

Examples: To repeat every week, set Interval=1 with WEEKLY frequency. To repeat every two months, set Interval=2 with MONTHLY frequency.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 6.

Required: Yes

ByMonth

Specifies which month the event should occur in (1-12, where 1=January, 12=December). Used with YEARLY frequency to schedule events in specific month.

Note: It does not accept multiple values in the same list

Type: Array of integers

Valid Range: Minimum value of 1. Maximum value of 12.

Required: No

ByMonthDay

Specifies which day of the month the event should occur on (1-31). Used with MONTHLY or YEARLY frequency to schedule events on specific date within a month.

Examples: [15] for events on the 15th of each month, [-1] for events on the last day of month.

Note: It does not accept multiple values in the same list. If a specified day doesn't exist in a particular month (e.g., day 31 in February), the event will be skipped for that month. This field cannot be used simultaneously with ByWeekdayOccurrence as they represent different scheduling approaches (specific dates vs. relative weekday positions).

Type: Array of integers

Valid Range: Minimum value of -1. Maximum value of 31.

Required: No

ByWeekdayOccurrence

Specifies which occurrence of a weekday within the month the event should occur on. Must be used with MONTHLY or YEARLY frequency.

Example: 2 corresponds to second occurrence of the weekday in the month. -1 corresponds to last occurrence of the weekday in the month

The weekday itself is specified separately in the HoursOfOperationConfig. Example: To schedule the recurring event for the 2nd Thursday of April every year, set ByWeekdayOccurrence=[2], Day=THURSDAY, ByMonth=[4], Frequency: YEARLY and INTERVAL=1.

Type: Array of integers

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Valid Range: Minimum value of -1. Maximum value of 4.

Required: No

RecurrencePattern

Contents

See Also