🗃️ Archive Degree Student
The archiveDegreeStudent mutation archives a student's enrollment on a degree. A reason is required. To suspend an enrollment temporarily instead, use Pause / Unpause Degree Student.
Identify the enrollment in one of two ways:
By
degreeStudentIddirectly, orBy the combination of
studentId+degreeId.
Input Parameters
Parameter | Type | Description |
|---|---|---|
| ID | ID of the degree enrollment. Provide this or |
| ID | ID of the student. Required if |
| ID | ID of the degree. Required if |
| String! | Reason the enrollment is being archived. |
Response Fields
Field | Type | Description |
|---|---|---|
| Boolean! | Returns |
Note: Subscribe to the
DEGREE_STUDENT_ARCHIVEDwebhook event to be notified when a degree enrollment is archived. See Webhooks.