Members and authors
Enrolling members
- Bulk limit: up to 100 users per request; more returns 422 (
bulk_limit_exceeded). - The cohort must be active and not expired, otherwise enrollment is rejected (409
cohort_not_active/cohort_expired). - Inactive or invalid users are filtered out and reported as skipped. If no eligible users remain, the request fails (422).
- Enrollment differs by cohort type:
- Mandatory cohorts — users are added directly as members.
- Non-mandatory cohorts — users receive a pending invitation and become members only after it is accepted. (The v6 API does not expose accept/decline operations for invitations.)
- Users who cannot be enrolled are not rejected with a top-level 409. How they are handled depends on the cohort type:
- Non-mandatory cohorts — the request fails with 422 (
invite_failed) and thedetailsarray pinpoints the offending user with a detail code:user_already_member,user_is_author,user_already_invited, oruser_not_community_member. - Mandatory cohorts — such users are skipped and listed in
skipped_users(each with a reason); the request only fails (422add_members_failed) when no user could be added.
- Non-mandatory cohorts — the request fails with 422 (
Authors
- Same 100-user bulk limit and inactive-user filtering as members.
- A user who is already a member, is the creator, or is already an author is skipped (reported in
skipped_userswith a reason) — not rejected with a top-level 409. - If none of the requested users can be added (all inactive, or all already authors/members/creator), the request fails with 422 (
add_authors_failed). Successful additions return 201 with the added ids and the skipped ones (with reasons). - The creator cannot be removed as an author → 409 (
cannot_remove_creator).
Roles and permissions
Every user resolves to exactly one role for a given cohort, in this priority:
- creator / author / member (an explicit role on the cohort)
- invited (a pending invitation)
- org_admin (organization administrator, otherwise unrelated)
- none
Who can do what:
| Capability | Allowed for |
|---|---|
| Manage the cohort (edit, sections, content, members, stats) | org admin, author, or creator |
| Manage authors | org admin or creator |
| View progress | the member themselves |