delete_sections: Delete sections from a course

View source: R/delete_sections.R

delete_sectionsR Documentation

Delete sections from a course

Description

This function allows to completely delete user created sections from a course. SIS created section will remain intact. The function first empties a section by deleting all section enrollments and then removing the section. Please note that this will not delete a user from a course. The function allows to either delete all sections from a course by default, or a specified id's

Usage

delete_sections(course_id, section_ids = "all")

Arguments

course_id

the canvas id of the course (integer)

section_ids

all by default or specify by entering canvas ids of the sections

Value

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

Examples


delete_sections(6348)

ICTO-FMG/uvacanvas documentation built on Dec. 6, 2024, 2:32 p.m.