Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
materials
object[]
required

Courses and pathways to assign, 1 to 20. materials × learners can be at most 500 per request

Required array length: 1 - 20 elements
learners
object[]
required

People to assign, 1 to 500, each by user id or email

Required array length: 1 - 500 elements
reviewers
object[]

Who reviews (up to 20) each learner's course submissions. Empty (the default) means no review. Reviews apply to courses, including the courses inside a pathway. Nobody reviews their own work

Maximum array length: 20
Example:
approvalPolicy
enum<string>
default:all

With several reviewers: whether all of them or any one must approve

Available options:
all,
any
dueDate
string<date>

Due date in YYYY-MM-DD format, today or later. Provide at most one of dueDate or dueInDays; with neither there is no due date

Example:

"2026-11-30"

dueInDays
integer

Due this many days after the assignment, 1 to 3650

Required range: 1 <= x <= 3650
Example:

30

reminders
object

Reminder emails to learners who haven't finished. Both are off by default

allowDuplicates
boolean
default:false

Give learners who already have a course in progress a second enrollment of it, instead of skipping them. Pathways are never assigned twice

Response

The assignments created, one per material, in request order

data
object