delete_enrollment: Delete enrollment

Description Usage Arguments Value

View source: R/simple_functions.R

Description

Conclude deactivate or delete an enrollment

Conclude deactivate or delete an enrollment

Usage

1
2
3
delete_enrollment(course_id, task = NULL, user_id)

delete_enrollment(course_id, task = NULL, user_id)

Arguments

course_id

the canvas id of the course (integer)

task

action to take on enrollment. Allowed values: conclude, delete, inactivate, deactivate. Default is delete (string)

user_id

canvas user id

Value

server response. Either 200 status code if everything went correctly or a specific http status warning.

server response. Either 200 status code if everything went correctly or a specific http status warning.


ICTO-FMG/uvacanvas documentation built on Jan. 24, 2022, 5:16 a.m.