POST
/
deliver
/
schedules
/
rrule
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/schedules/rrule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "start_date": "2025-01-01",
  "recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
  "occurrence_count": 3
}'
{
  "start_date": "2025-01-01",
  "rrule_string": "<string>",
  "rrule_readable": "<string>",
  "occurrences": [
    "2023-12-25"
  ]
}

Authorizations

​
Authorization
string
header
required

The auth token received from Authentication endpoints.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
start_date
string
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
application/json
200 response.
​
start_date
string
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[]
required

List of next occurrence dates

Was this page helpful?