Skip to navigation
EndpointsLive Sessions

Create Live Session

Create a live session in the organization.

start_date and end_date are wall-clock times in time_zone, without offset. Participants can be invited on creation with participant_user_ids or later with the participants endpoint.

User ids are learning user ids: take them from user.id in GET /org/{organization_slug}/learning/users/ or from learning_user_id in GET /org/{organization_slug}/users/user-organizations/ (where user.id is the centralized id). A centralized user id targets a different person.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Headers

Secret-AccessstringRequired

Request

This endpoint expects an object.
session_titlestringRequired1-255 characters
Title of the session. If the organization already has one with this title, a numeric suffix is appended and the created title is returned in the response
start_datedatetimeRequired

Start of the session as wall-clock time in time_zone, without offset (YYYY-MM-DDTHH:MM:SS)

end_datedatetimeRequired

End of the session as wall-clock time in time_zone, without offset (YYYY-MM-DDTHH:MM:SS)

time_zoneenumRequired
Time zone the dates are expressed in
type_sessionenumRequired

ONLINE for a virtual session, PRESENCE for an on-site one

Allowed values:
descriptionstringRequired>=1 character

Description shown in the session detail. Required: the learning service stores it as a non-null column

locationstringOptional<=500 characters
Meeting url for ONLINE sessions, physical address for PRESENCE ones
instructor_namestringOptional<=255 characters
Name shown as the instructor of the session
cover_file_idintegerOptional>=1
Id of an uploaded file to use as the session cover image
resource_file_idslist of integersOptional
Ids of uploaded files attached to the session as resources
participant_user_idslist of integersOptional

Learning user ids invited on creation. More participants can be added later with the participants endpoint. These are learning user ids, not the centralized_user_id used by the users and enrollments endpoints: sending one in place of the other targets a different person. Get them from user.id in GET /org/{organization_slug}/learning/users/ (filter with user_email; results[].id is the membership id, not the user id), or from learning_user_id in GET /org/{organization_slug}/users/user-organizations/ (there user.id is the centralized id)

has_qr_availablebooleanOptionalDefaults to false
Generate a QR code so attendees can register their own attendance
issues_certificatebooleanOptionalDefaults to false
Whether the session issues a certificate

Response

Live session created
messagestring
Message of the response
codestring
Internal code of the response
datetimestring
Datetime of the API in ISO Format
dataobjectOptional
The created live session

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error