Skip to main content
POST
Validate and parse RRULE string

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
start_date
string<date>
required

The date when the schedule starts, in YYYY-MM-DD format.

Example:

"2025-01-01"

recurrence
string
required

Recurrence of the schedule in iCalendar RRULE format

Example:

"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"

occurrence_count
integer

Number of occurrences to return. Defaults to 2 if not specified.

Required range: 1 <= x <= 5

Response

200 response.

start_date
string<date>
required

The date when the schedule starts, in YYYY-MM-DD format.

Example:

"2025-01-01"

rrule_string
string
required

The original RRULE string

rrule_readable
string
required

Human readable form of the RRULE

occurrences
string<date>[]
required

List of next occurrence dates