Skip to navigation

UpdateRecurringLecture

View as Markdown

Update recurring lecture

This API endpoint allows you to update a recurring lecture by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the lecture’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 lecture.

    • 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

Lecture status

1: SCHEDULED

2: COMPLETED

3: CANCELLED

4: DELETED

Path parameters

idstringRequired

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
idintegerRequired
startDateTimedatetimeRequired
titlestringRequired
classCourseobjectRequired
durationintegerRequired
classroomobjectRequired
meetingPasswordstringRequired
rrulestringRequired

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

OK
idinteger
startDateTimedatetime
titlestring
classCourseobject
durationinteger
classroomobject
meetingPasswordstring
rrulestring