[BETA] Add students to a group

Add a student to a group, without rewriting its membership. This endpoint never removes anyone.

Use it to turn a single enrolment event from your system into a single call: PUT /v3/groups/{id}/students requires reading the group first and sending back its whole membership.

One student per call. Send studentIds or studentExternalReferenceIds, never both, with exactly one identifier. The field is an array so the limit can be raised later without breaking your integration. To replace a whole membership use PUT /v3/groups/{id}/students; to move a batch without touching courses use POST /v3/groups/students/batch-upsert.

Safe to replay. A student already in the group is reported in unchangedCount — no error, no duplicate. Replaying a call that failed partway also finishes the job. The removal endpoint behaves differently on purpose, see DELETE /v3/groups/{id}/students.

All or nothing. An unknown student identifier fails the whole call and writes nothing.

Rate limit: standard. Concurrency: two identical calls sent at the same moment share a single execution; a call replayed after the response has come back runs again in full.

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

The internal Edusign group ID

Query Params
boolean
Defaults to true

Optional, defaults to true. When true, the student is also added to the upcoming courses of the group: they appear on the attendance of each of them, an absence they had already declared over one of those time slots is carried over, and the recipients of the surveys attached to those courses are updated. A student already on a course is left as they are. When false, only the group membership changes and the courses are left untouched - use this when your own system drives course attendance. Courses that have already started, and locked courses, are never affected either way.

Body Params
studentIds
array of strings

Internal Edusign student IDs to add. Mutually exclusive with studentExternalReferenceIds.

studentIds
studentExternalReferenceIds
array of strings

External reference IDs (apiId) of the students to add. Mutually exclusive with studentIds.

studentExternalReferenceIds
Responses

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