API Reference

[BETA] Assign students to a course

put
https://api.edusign.com/v3/courses//students

Assign students and/or groups to a single course. Uses replace semantics: provided student/group lists replace existing enrollments. Omitted fields remain unchanged.

XOR rules:

  • studentIds XOR studentExternalReferenceIds (optional)
  • groupIds XOR groupExternalReferenceIds (optional)
  • At least one of students or groups must be provided

Error codes: AMBIGUOUS_STUDENT_IDENTIFIER, AMBIGUOUS_GROUP_IDENTIFIER, MISSING_ENROLLMENT_DATA, COURSE_NOT_FOUND, ARCHIVED_COURSE_EXISTS, STUDENTS_NOT_FOUND, ARCHIVED_STUDENT_EXISTS, GROUPS_NOT_FOUND, ARCHIVED_GROUP_EXISTS, MAX_STUDENTS_EXCEEDED.

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 Course ID

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
groupIds
array of strings

Array of internal Edusign group IDs

groupIds
groupExternalReferenceIds
array of strings

Array of external reference IDs for groups

groupExternalReferenceIds
Responses

Updated 4 days ago

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

Updated 4 days ago