[BETA] Replace the students of a group

Replace the membership of a group with the provided list of students. Students present in the payload but not in the group are added; students currently in the group but absent from the payload are removed; students in both are unchanged.

Body: studentIds XOR studentExternalReferenceIds. An empty array clears all members.

Query (required): cascadeToCourses controls whether membership changes propagate to courses linked to the group:

  • cascadeToCourses=true — on add, students are enrolled in all future unlocked courses linked to the group (STUDENT_STATES and matching ABSENCES are created; already-enrolled students are skipped). On remove, students are unenrolled from those courses, except if they remain member of another group attached to the same course (multi-group protection). Survey recipients are kept in sync.
  • cascadeToCourses=false — only the STUDENT_GROUPS_STUDENTS join table is touched. Linked courses, STUDENT_STATES, ABSENCES and surveys are left untouched. Use this when the connector manages course enrollment independently of group membership.

Past courses, locked courses and group attribute changes (name, description, parent, logo) are never affected by this endpoint.

Errors: AMBIGUOUS_STUDENT_IDENTIFIER (400), MISSING_STUDENT_DATA (400), GROUP_NOT_FOUND (404), STUDENTS_NOT_FOUND (404), ARCHIVED_GROUP_EXISTS (422), ARCHIVED_STUDENT_EXISTS (422).

Rate limit: HEAVY. Idempotency: 5s deduplication window.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The internal Edusign group ID

Query Params
boolean
required

Required. When true, membership changes propagate to STUDENT_STATES of all future unlocked courses linked to the group: added students get enrolled (with matching ABSENCES), removed students get unenrolled (with multi-group protection — students still in another group attached to the same course are preserved). When false, only the STUDENT_GROUPS_STUDENTS table is touched and linked courses are left untouched. Past and locked courses are never affected either way.

Body Params
studentIds
array of strings

Array of internal Edusign student IDs

studentIds
studentExternalReferenceIds
array of strings

Array of external reference IDs for students

studentExternalReferenceIds
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json