Bulk Invite Users
Bulk create/invite 1–100 users — students (optionally each with a parent), tutors,
and parents — in one call. Each row carries a type discriminator.
Auth is all-or-nothing: the key must hold every scope the batch’s row types require
(students:write for student/parent rows, tutors:write for tutor rows) or the whole
request is 403. Provisioning is then per-row and independent — one row’s failure never
rolls back the others. Each input row maps to one results[] entry (same order, by
index) with a status:
ok— newly provisioned (created= whether a new login was made)exists— already an accepted member of this org (idempotent no-op)error— could not provision (errorcarries a human-readable reason)
Honours Idempotency-Key (the whole batch result is replayed on retry).
Authorizations
Org API key as Token token=ei_live_...
Headers
Body
POST /v1/users/bulk-invite — create/invite 1–100 users (students, tutors, and/or
parents) in one call. Each row is provisioned independently: one row's failure never
rolls back the others (see the per-row results).
1 - 100 elementsA student row in POST /v1/users/bulk-invite (optionally with a parent created + linked atomically). Mirrors POST /v1/students.
- BulkInviteStudent
- BulkInviteTutor
- BulkInviteParent