使用 Canvas Tools 执行 Canvas Create Enrollment

end_atstring

ISO8601 end date/time for enrollment. If unspecified, may follow course/term dates or be indefinite.

notifyboolean

If true, sends notification to user. Default notification behavior varies if null/false.

role_idinteger

ID of a custom course-level role, potentially overriding `enrollment_type`.

user_idstring

必填

The ID of the user to be enrolled in the course.

start_atstring

ISO8601 start date/time for enrollment. If unspecified, may start immediately or align with course/term settings.

course_idstring

必填

The ID of the course in which to enroll the user.

sis_user_idstring

SIS (Student Information System) ID for the user; an alternative identifier.

self_enrolledboolean

True if self-initiated enrollment, typically with `self_enrollment_code`.

integration_idstring

External unique identifier for linking with third-party systems.

enrollment_typestring

Enrollment type determining role/permissions. Canvas defaults to 'StudentEnrollment' if unspecified.

enrollment_statestring

State of enrollment: 'active', 'invited' (requires user acceptance), or 'inactive'.

course_section_idinteger

ID of a specific course section for enrollment. If omitted, user enrolls in the course generally.

Canvas Create Enrollment