Inviting Students to a Degree using API

This guide explains how colleges using Canvas or other systems can utilize the addStudentToDegree. This API mutation can be used to invite students to degrees, avoid account duplication, and ensure accurate billing and payment tracking.

Key Concepts

1. Use External ID to Prevent Account Duplication

What is External ID?
External ID refers to a unique, unchangeable identifier for students (e.g., Canvas User ID). It ensures each student is accurately identified across systems.

Why Use External ID?
Emails may change, but the External ID remains constant. Using External IDs helps prevent duplicate accounts when students use multiple email addresses.

2. Required and Optional API Fields

Example Request

🚀 Request (Try It)

Example Response

{
  "data": {
    "addStudentToDegree": {
      "id": "1cb91e3f-2eab-4c8d-902f-944c86937dfc"
    }
  }
}

Invitation Logic

The API handles student invitations as follows:

1. If externalId exists:
   The system invites the user associated with the externalId to the degree. Any email provided in the request is ignored.

2. If externalId does not exist but email exists:
   The system invites the user associated with the email to the degree.

3. If neither externalId nor email exists:
   The system creates a new user and invites them to the degree.

Common Scenarios and Best Practices

Inviting Students Using External IDs

• Use the externalId when the student already exists in Canvas or another integrated LMS.
• This prevents duplicate records and ensures accurate syncing of student data.

Specifying Tuition Costs and Currency

• Override the default tuition cost for specific students by passing tuitionCost and currency values.
• If no values are provided, Woolf will apply the default tuition cost and currency set for the degree.

Handling Missing Information

• If externalId or email is missing, ensure the necessary data is collected before making the API request.
• Always verify the degreeId from Woolf AMS to avoid errors.

FAQs

Related Articles