Skip to navigation
EndpointsLive Sessions

Assign Live Session Participants

Invite users to a live session.

The assignment is processed in background: a 202 means the request was accepted for the users reported in total_users_accepted. Users that do not belong to the organization come back in invalid_user_ids and are not assigned; when none of them does, the response is a 422.

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
live_session_idintegerRequired>=1
Id of the live session, as returned by GET

Headers

Secret-AccessstringRequired

Request

This endpoint expects an object.
user_idslist of integersRequired

Learning user ids to invite. 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)

send_notificationbooleanOptionalDefaults to false
Send the invitation email to the assigned users, when the organization has that notification enabled

Response

Assignment queued for background processing
messagestring
Message of the response
codestring
Internal code of the response
datetimestring
Datetime of the API in ISO Format
dataobjectOptional
Participants assignment details

Errors

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