enrollment: Enroll user(s) into a course (or multiple courses)

In daranzolin/rcanvas: R Client for Canvas API

Enroll user(s) into a course (or multiple courses)

Description

Enrolls the given user(s) into the course. If multiple course_ids are given, it should be of the same length as user_id, and each user will be enrolled into the corresponding course.

Usage

add_enrollments(
  course_id,
  user_ids,
  type = c("StudentEnrollment", "TeacherEnrollment", "TaEnrollment",
    "ObserverEnrollment", "DesignerEnrollment"),
  state = c("invited", "active", "inactive"),
  section = F,
  ...
)

Arguments

course_id	ID of the course (or section, see below)
type	enrollment type
state	enrollment state
section	if TRUE, course_id should be a section_id instead of a course_id and students will be enrolled into this section
...	any other arguments passed to the API
user_id	ID of the user

daranzolin/rcanvas documentation built on May 18, 2024, 2:33 p.m.