AddRecurringEvent | DreamClass

curl -X POST https://api.dreamclass.io/dreamclassapi/v1/calendar/event/recurring \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "Math",
  "duration": 15,
  "createdBy": "test@mail.com",
  "visibleToStudents": true,
  "visibleToProfessors": true,
  "semester": {
    "id": 1
  },
  "rrule": "DTSTART;TZID=US/Pacific:20241022T093000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1"
}'

{
  "id": 10,
  "title": "Math",
  "duration": 15,
  "createdBy": "test@mail.com",
  "visibleToStudents": true,
  "visibleToProfessors": true,
  "rrule": "DTSTART;TZID=US/Pacific:20241022T093000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1"
}

Add recurring event

This API endpoint allows you to add a recurring event by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the event’s start date and recurrence pattern.

Parameters

rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule consists of:
- A DTSTART element on the first line, specifying the start date and time of the event.
- An RRULE element on the second line, specifying the recurrence pattern (e.g. daily, weekly, monthly).

Each element must be on its own line, separated by a newline character (\n). Give both times in UTC (a trailing Z), for example:

DTSTART:20260907T090000Z
RRULE:FREQ=WEEKLY;BYDAY=MO,WE;UNTIL=20261218T235959Z

Add recurring event This API endpoint allows you to add a recurring event by specifying a recurrence rule. The recurrence rule must follow the [iCalendar specification](https://icalendar.org), using the `DTSTART` and `RRULE` elements to define the event's start date and recurrence pattern. #### Parameters - rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule consists of: - A `DTSTART` element on the first line, specifying the start date and time of the event. - An `RRULE` element on the second line, specifying the recurrence pattern (e.g. daily, weekly, monthly). Each element must be on its own line, separated by a newline character (`\n`). Give both times in UTC (a trailing `Z`), for example: ``` DTSTART:20260907T090000Z RRULE:FREQ=WEEKLY;BYDAY=MO,WE;UNTIL=20261218T235959Z ```

Headers

Request

This endpoint expects an object.

titlestringRequired

durationintegerRequired

createdBystringRequiredformat: "email"

visibleToStudentsbooleanRequired

visibleToProfessorsbooleanRequired

semesterobjectRequired

rrulestringRequired

descriptionanyOptional

Response headers

ExpiresstringOptional

Cache-ControlstringOptional

Access-Control-Allow-HeadersstringOptional

X-XSS-ProtectionstringOptional

PragmastringOptional

Access-Control-Allow-MethodsstringOptional

X-Frame-OptionsstringOptional

Access-Control-Expose-HeadersstringOptional

Access-Control-Allow-OriginstringOptional

Access-Control-Allow-CredentialsstringOptional

X-Content-Type-OptionsstringOptional

Access-Control-Max-AgestringOptional

Response

idinteger

titlestring

durationinteger

createdBystringformat: "email"

visibleToStudentsboolean

visibleToProfessorsboolean

rrulestring

descriptionanyOptional

Add recurring event

Parameters

rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule consists of:
- A DTSTART element on the first line, specifying the start date and time of the event.
- An RRULE element on the second line, specifying the recurrence pattern (e.g. daily, weekly, monthly).

Each element must be on its own line, separated by a newline character (\n). Give both times in UTC (a trailing Z), for example:

DTSTART:20260907T090000Z
RRULE:FREQ=WEEKLY;BYDAY=MO,WE;UNTIL=20261218T235959Z