⏸️ Pause / Unpause Degree Student

The pauseDegreeStudent and unpauseDegreeStudent mutations allow an administrator to temporarily suspend a student's enrollment on a degree and later restore it. Pausing sets the enrollment's status to PAUSED, records the pause window, and logs an activity entry capturing the previous status. Unpausing restores the enrollment to its previous status (or ACTIVE / PENDING depending on activation criteria) and logs a corresponding activity entry.

Both mutations identify the enrollment in one of two ways:

By degreeStudentId directly, or
By the combination of studentId + degreeId.

If both forms are provided, degreeStudentId takes precedence. If neither a valid degreeStudentId nor a valid studentId + degreeId pair is supplied, the call fails with INVALID_INPUT.

To end an enrollment permanently instead, use Archive Degree Student.

pauseDegreeStudent

Pauses a degree student enrollment. Records the pause window and writes an activity entry with the previous status as dataPrev.

Input Parameters

Parameter	Type	Description
`degreeStudentId`	ID	ID of the degree enrollment to pause. Provide this or `studentId` + `degreeId`.
`studentId`	ID	ID of the student. Required if `degreeStudentId` is not provided.
`degreeId`	ID	ID of the degree. Required if `degreeStudentId` is not provided.
`pauseFrom`	Date	Optional start date of the pause window (UTC, `YYYY-MM-DD`). Defaults to the current date.
`pauseTo`	Date	Optional end date of the pause window (UTC, `YYYY-MM-DD`). If supplied, the student is auto-unpaused on this date by a daily background job. Must be on or after `pauseFrom`.
`reason`	String!	Reason the enrollment is being paused. Stored on the activity record.

Response Fields

Field	Type	Description
`success`	Boolean!	Returns `true` if the enrollment was successfully paused.

Errors

Code	Meaning
`INVALID_INPUT`	Neither `degreeStudentId` nor the `studentId` + `degreeId` pair was provided, or `pauseFrom` is after `pauseTo`.
`DEGREE_STUDENT_NOT_FOUND`	No matching degree enrollment exists for the identifiers provided.

🚀 Request (Try It)

unpauseDegreeStudent

Unpauses a previously paused degree student enrollment. Restores the student's status using the following precedence:

The previous status recorded on the most recent pauseDegreeStudent activity (dataPrev.status), if known.
Otherwise, ACTIVE if the student meets activation criteria.
Otherwise, PENDING.

Input Parameters

Parameter	Type	Description
`degreeStudentId`	ID	ID of the degree enrollment to unpause. Provide this or `studentId` + `degreeId`.
`studentId`	ID	ID of the student. Required if `degreeStudentId` is not provided.
`degreeId`	ID	ID of the degree. Required if `degreeStudentId` is not provided.

Response Fields

Field	Type	Description
`success`	Boolean!	Returns `true` if the enrollment was successfully unpaused.

Errors

Code	Meaning
`INVALID_INPUT`	Neither `degreeStudentId` nor the `studentId` + `degreeId` pair was provided.
`DEGREE_STUDENT_NOT_FOUND`	No matching degree enrollment exists for the identifiers provided.

🚀 Request (Try It)

DegreeStudentStatus

Possible values for a degree enrollment's status:

PENDING, ACTIVE, REJECTED, SUBMITTED, COMPLETED, ARCHIVED, PAUSED.

DegreeStudent

Degree enrollments are returned in the degrees field of the student and students queries.

Field	Type	Description
`id`	ID!	Degree enrollment ID.
`degreeId`	ID!	Degree the student is enrolled on.
`updated`	DateTime!	Timestamp the enrollment was last updated.
`created`	DateTime!	Timestamp the enrollment was created.
`status`	DegreeStudentStatus	Current enrollment status. Becomes `PAUSED` while a pause is active.
`identityStatus`	ComplianceStepStatus!	Status of the identity onboarding step (`PENDING`, `REJECTED`, `SUBMITTED`, `COMPLETED`).
`qualificationStatus`	ComplianceStepStatus!	Status of the qualification onboarding step.
`motivationStatus`	ComplianceStepStatus!	Status of the motivation onboarding step.
`agreementStatus`	ComplianceStepStatus!	Status of the agreement onboarding step.
`approvalStatus`	ComplianceStepStatus!	Status of the college approval step.
`workloadConsumed`	Int!	Workload consumed on the degree.
`workloadRequired`	Int!	Workload required to complete the degree.
`workloadCompleted`	Int!	Workload completed on the degree.
`onboardingStarted`	DateTime	When the student started onboarding.
`identityTimestamp`, `qualificationTimestamp`, `motivationTimestamp`, `agreementTimestamp`, `approvalTimestamp`, `paymentTimestamp`	DateTime	When each onboarding step was last updated.
`paymentStatus`	DegreeStudentPaymentStatus!	Payment status (`UNPAID`, `PAID`).
`activated`	DateTime	When the enrollment was activated.
`rejectionReason`	String	Reason for rejection, if applicable.

Note: The pause window (pauseFrom / pauseTo) is an input to pauseDegreeStudent only; it is not returned on DegreeStudent.

⏸️ Pause / Unpause Degree Student

pauseDegreeStudent

Input Parameters

Response Fields

Errors

🚀 Request (Try It)

unpauseDegreeStudent

Input Parameters

Response Fields

Errors

🚀 Request (Try It)

Related Types

DegreeStudentStatus

DegreeStudent