canvas_enroll_user
Enroll a user in a Canvas course with options for enrollment type, state (invited or active), and email notification. Specify user by Canvas or SIS ID, and optionally set section or course.
Instructions
Enrol a user in the course. MUTATES the roster.
Defaults to state=invited and notify=False: the person gets an invitation they must accept, and no email goes out until you ask for one. Pass enrollment_state="active" to place them straight onto the roster.
Args: user_id: numeric Canvas user id. "sis_user_id:ABC123" enrols by SIS id instead, which is usually what a registrar export gives you. enrollment_type: StudentEnrollment, TeacherEnrollment, TaEnrollment, ObserverEnrollment, or DesignerEnrollment. enrollment_state: invited (default) or active. notify: send Canvas's notification email (default False). section_id: enrol into a specific section instead of the default one. course_id: numeric course id; defaults to CANVAS_DEFAULT_COURSE_ID.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"user_id": "<user_id>"
},
"name": "canvas_enroll_user"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notify | No | ||
| user_id | Yes | ||
| course_id | No | ||
| section_id | No | ||
| enrollment_type | No | StudentEnrollment | |
| enrollment_state | No | invited |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |