Skip to main content

Create LessonSession

POST$BEEDEEZ_API/v1/lesson-session

Create LessonSession

Create a LessonSession with the given parameters

Request Body — REQUIRED
title string — REQUIRED
description string — REQUIRED
lessonId string — REQUIRED
presenters string[] — REQUIRED
status string — REQUIRED

Possible values: [draft, online, cancelled, deleted]

type string — REQUIRED

Possible values: [fixed-date, open]

registrationGroupType string — REQUIRED

Possible values: [unlimited, one-per-lesson]

quota object
type string — REQUIRED

Possible values: [none, max, min, min-max]

min double
max double
registrationsPeriod object
startDate date-time
endDate date-time
location object
room string
name string
endDate string
startDate string
isAttendanceSession boolean
isSignedSession boolean
hasLive boolean
onsite boolean
codes object[]
type string

Possible values: [qr, barcode, access]

value string
Responses
200

Ok

Schema — OPTIONAL
isLive boolean
quotas object
type string

Possible values: [none, max, min, min-max]

min double — OPTIONAL
max double — OPTIONAL
status string

Possible values: [draft, online, cancelled, deleted]

endDate date-time
startDate date-time
creationDate date-time
presenters string[]
codes object[]
type string — OPTIONAL

Possible values: [qr, barcode, access]

value string — OPTIONAL
location object
lang string — OPTIONAL
name string — OPTIONAL
name_i18n object[] — OPTIONAL
lang string — OPTIONAL
value string — OPTIONAL
room string — OPTIONAL
description string — OPTIONAL
description_i18n object[] — OPTIONAL
lang string — OPTIONAL
value string — OPTIONAL
address string — OPTIONAL
onSite boolean
creatorId string
lessonId string
registrations object[]
status string

Possible values: [waiting-list, pending-validation, approved, rejected, cancelled]

signatureDate date-time
attendance string — OPTIONAL

Possible values: [attended, absent, none]

registrationDate date-time — OPTIONAL
userId string
description string
title string
guid string
id string
400

Invalid payload

Schema — OPTIONAL
statusCode double
kind string
message string

Authorization

AuthorizationBearer access tokenadmin scopeHow to get one

Request body

object
titlestringrequired
descriptionstringrequired
lessonIdstringrequired
presentersstring[]required
statusstringrequired
draftonlinecancelleddeleted
typestringrequired
fixed-dateopen
registrationGroupTypestringrequired
unlimitedone-per-lesson
quotaobjectoptional
typestringrequired
nonemaxminmin-max
mindoubleoptional
maxdoubleoptional
registrationsPeriodobjectoptional
startDatedate-timeoptional
endDatedate-timeoptional
locationobjectoptional
roomstringoptional
namestringoptional
endDatestringoptional
startDatestringoptional
isAttendanceSessionbooleanoptional
isSignedSessionbooleanoptional
hasLivebooleanoptional
onsitebooleanoptional
codesobject[]optional
typestringoptional
qrbarcodeaccess
valuestringoptional

Response

200 OKobject
isLiveboolean
quotasobject
typestring
nonemaxminmin-max
mindouble
maxdouble
statusstring
draftonlinecancelleddeleted
endDatedate-time
startDatedate-time
creationDatedate-time
presentersstring[]
codesobject[]
typestring
qrbarcodeaccess
valuestring
locationobject
langstring
namestring
name_i18nobject[]
langstring
valuestring
roomstring
descriptionstring
description_i18nobject[]
langstring
valuestring
addressstring
onSiteboolean
creatorIdstring
lessonIdstring
registrationsobject[]
statusstring
waiting-listpending-validationapprovedrejectedcancelled
signatureDatedate-time
attendancestring
attendedabsentnone
registrationDatedate-time
userIdstring
descriptionstring
titlestring
guidstring
idstring

Errors

400Invalid payload
Stuck on an integration?
Write to the developer team with your request ID and we'll get back to you quickly.