Skip to main content
POST
Enroll users into an institution

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string
required

Institution ID to enroll users into

Pattern: ^[0-9a-fA-F]{24}$
Example:

"67826dfe5d387207aabd6fc1"

users
string[]
required

Array of user IDs to enroll

Pattern: ^[0-9a-fA-F]{24}$
Example:
accountType
enum<string>
required

Role for the new memberships

Available options:
user,
admin
Example:

"user"

entitlements
string[]

Admin entitlements to grant (only relevant when accountType is admin)

Example:

Response

Users enrolled successfully

success
boolean
Example:

true

created
integer

Number of users successfully enrolled

Example:

3

skipped
integer

Number of users skipped (already enrolled or invalid)

Example:

1

message
string

Human-readable result summary

Example:

"Enrolled 3 user(s). Skipped 1 (already enrolled or invalid)."