Skip to main content
POST
Bulk Invite Users

Authorizations

Authorization
string
header
required

Org API key as Token token=ei_live_...

Headers

Idempotency-Key
string | null

Body

application/json

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).

users
(BulkInviteStudent · object | BulkInviteTutor · object | BulkInviteParent · object)[]
required
Required array length: 1 - 100 elements

A student row in POST /v1/users/bulk-invite (optionally with a parent created + linked atomically). Mirrors POST /v1/students.

Response

Successful Response

POST /v1/users/bulk-invite response — results is per-row (same order as the request) and summary rolls up the counts.

results
BulkInviteResultItem · object[]
summary
BulkInviteSummary · object

Roll-up counts for a bulk invite (ok + exists + errors == total).