Skip to main content
POST
/
deliver
/
schedules
/
rrule
Validate and parse RRULE string
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
}
'
import requests

url = "https://api-sandbox.orum.io/deliver/schedules/rrule"

payload = {
"start_date": "2025-01-01",
"recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
"occurrence_count": 3
}
headers = {
"Orum-Version": "<orum-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'Orum-Version': '<orum-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
start_date: '2025-01-01',
recurrence: 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR',
occurrence_count: 3
})
};

fetch('https://api-sandbox.orum.io/deliver/schedules/rrule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.orum.io/deliver/schedules/rrule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_date' => '2025-01-01',
'recurrence' => 'RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR',
'occurrence_count' => 3
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Orum-Version: <orum-version>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-sandbox.orum.io/deliver/schedules/rrule"

payload := strings.NewReader("{\n \"start_date\": \"2025-01-01\",\n \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n \"occurrence_count\": 3\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Orum-Version", "<orum-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-sandbox.orum.io/deliver/schedules/rrule")
.header("Orum-Version", "<orum-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"2025-01-01\",\n \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n \"occurrence_count\": 3\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/schedules/rrule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_date\": \"2025-01-01\",\n \"recurrence\": \"RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR\",\n \"occurrence_count\": 3\n}"

response = http.request(request)
puts response.read_body
{
  "start_date": "2025-01-01",
  "rrule_string": "<string>",
  "rrule_readable": "<string>",
  "occurrences": [
    "2023-12-25"
  ]
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}

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