Create a path session

🔑

Required OAuth scope: paths:write.

Creates a path session for the given path.

Required fields include the session name, start date, the ID of the main instructor, and registration validation options.

On success, the API returns the full session object, including your input and system-generated fields like _id, timestamps (createdAt, modifiedAt), and groupId (owner group).

About session owner group assignment (groupId)
You don't provide groupId directly. The system assigns an owner group to the newly created path session automatically based on the mainInstructorId:

  1. Identify eligible groups: The system retrieves all groups where the mainInstructorId has at least the author role.
  2. Group selection logic:
If eligible groups exist, they are sorted, and the first group in the sorted list is selected as the session owner group. The sorting criteria are applied in this order:
    • Public groups first.
    • Next, groups are sorted by their hierarchy depth in ascending order (meaning groups higher up in the organizational tree are chosen first).
    • Finally, groups are sorted by the number of users they contain in descending order (larger groups come first).
  3. Fallback:
If the mainInstructorId does not have the author role in any group, the system defaults to using the path's owner group as the session owner group.
Path Params
string
required
^[a-fA-F0-9]{24}$

The unique ID of the path.

Body Params
string
required
^[a-fA-F0-9]{24}$

The unique ID of the main instructor of the path session.

string
enum
required

The registration request validation options for open access registrations. Options are:

  • disabled: There is no validation for registration.
  • instructors: The instructors validate the registration request.
  • managers: The managers validate the registration request.
  • adminsAndManagers: The managers and group admin validate the registration request.
  • adminsCoachesInstructorsManagers:Managers, instructors, group admins and coaches validate the registration request.
Allowed:
date-time
required

The date and time when the path session starts, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

date-time

The date and time when the path session ends, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

integer
≥ 1

The maximum number of learners that can self enroll in the path session.

automaticReenrollment

The automatic reenrollment settings if enabled for the path session.

ipFiltering
object

The IP filtering configuration of the path session.

string
required
length ≥ 1

The title of the path session.

string
length ≥ 1

The additional information of the path session.

instructorIds
array of strings
length ≤ 100

The list of unique IDs of the co-instructors of the path session.

instructorIds
Headers
string
enum
required

The version of the API.

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json