The subject of the notification.

The message body of the notification.

The start date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

The end date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

The icon to display with the notification. Note: Defaults to warning.

Allowed values: warning, information, question, error, calendar

The role(s) to send global notification to. Note: ommitting this field will send to everyone Example:

account_notification_roles: ["StudentEnrollment", "TeacherEnrollment"]

The subject of the notification.

The message body of the notification.

The start date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

The end date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

The icon to display with the notification.

Allowed values: warning, information, question, error, calendar

The role(s) to send global notification to. Note: ommitting this field will send to everyone Example:

account_notification_roles: ["StudentEnrollment", "TeacherEnrollment"]

The parameters will vary for each report. To fetch a list of available parameters for each report, see List Available Reports. A few example parameters have been provided below. Note that the example parameters provided below may not be valid for every report.

The id of the course to report on. Note: this parameter has been listed to serve as an example and may not be valid for every report.

If true, user data will be included. If false, user data will be omitted. Note: this parameter has been listed to serve as an example and may not be valid for every report.

Array of additional information to include.

“lti_guid”

the 'tool_consumer_instance_guid' that will be sent for this account on LTI launches

“registration_settings”

returns info about the privacy policy and terms of use

“services”

returns services and whether they are enabled (requires account management permissions)

Allowed values: lti_guid, registration_settings, services

List of permissions to check against the authenticated user. Permission names are documented in the Create a role endpoint.

If true, the entire account tree underneath this account will be returned (though still paginated). If false, only direct sub-accounts of this account will be returned. Defaults to false.

If true, include only courses with at least one enrollment. If false, include only courses with no enrollments. If not present, do not filter on course enrollment status.

If set, only return courses that have at least one user enrolled in in the course with one of the specified enrollment types.

Allowed values: teacher, student, ta, observer, designer

If true, include only published courses. If false, exclude published courses. If not present, do not filter on published status.

If true, include only completed courses (these may be in state 'completed', or their enrollment term may have ended). If false, exclude completed courses. If not present, do not filter on completed status.

If true, include only blueprint courses. If false, exclude them. If not present, do not filter on this basis.

If true, include only courses that inherit content from a blueprint course. If false, exclude them. If not present, do not filter on this basis.

List of User IDs of teachers; if supplied, include only courses taught by one of the referenced users.

List of Account IDs; if supplied, include only courses associated with one of the referenced subaccounts.

If present, only return courses that have at least one enrollment. Equivalent to 'with_enrollments=true'; retained for compatibility.

If set, only return courses that are in the given state(s). By default, all states but “deleted” are returned.

Allowed values: created, claimed, available, completed, deleted, all

If set, only includes courses from the specified term.

The partial course name, code, or full ID to match and return in the results list. Must be at least 3 characters.

• All explanations can be seen in the Course API index documentation

• “sections”, “needs_grading_count” and “total_scores” are not valid options at the account level

Allowed values: syllabus_body, term, course_progress, storage_quota_used_mb, total_students, teachers, account_name

The column to sort results by.

Allowed values: course_name, sis_course_id, teacher, account_name

The order to sort the given column by.

Allowed values: asc, desc

The filter to search by. “course” searches for course names, course codes, and SIS IDs. “teacher” searches for teacher names

Allowed values: course, teacher

Updates the account name

Updates the account sis_account_id Must have manage_sis permission and must not be a root_account.

The default time zone of the account. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

The default course storage quota to be used, if not otherwise specified.

The default user storage quota to be used, if not otherwise specified.

The default group storage quota to be used, if not otherwise specified.

Restrict students from viewing courses after end date

Lock this setting for sub-accounts and courses

Restrict students from viewing courses before start date

Lock this setting for sub-accounts and courses

Disable comments on announcements

Lock this setting for sub-accounts and courses

Restrict students from viewing future enrollments in course list

Lock this setting for sub-accounts and courses

Give this a set of keys and boolean values to enable or disable services matching the keys

The name of the new sub-account.

The account's identifier in the Student Information System.

The default course storage quota to be used, if not otherwise specified.

The default user storage quota to be used, if not otherwise specified.

The default group storage quota to be used, if not otherwise specified.

The id of the user to promote.

DEPRECATED

The user's admin relationship with the account will be

created with the given role. Defaults to 'AccountAdmin'.

The user's admin relationship with the account will be created with the given role. Defaults to the built-in role for 'AccountAdmin'.

Send a notification email to the new admin if true. Default is true.

DEPRECATED

Account role to remove from the user. Defaults to

'AccountAdmin'. Any other account role must be specified explicitly.

The user's admin relationship with the account will be created with the given role. Defaults to the built-in role for 'AccountAdmin'.

Scope the results to those with user IDs equal to any of the IDs specified here.

The url to the external rss or atom feed

If given, only feed entries that contain this string in their title will be imported

Defaults to “full”

Allowed values: full, truncate, link_only

List of context_codes to retrieve announcements for (for example, course_123). Only courses are presently supported. The call will fail unless the caller has View Announcements permission in all listed courses.

Only return announcements posted since the start_date (inclusive). Defaults to 14 days ago. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

Only return announcements posted before the end_date (inclusive). Defaults to 28 days from start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. Announcements scheduled for future posting will only be returned to course administrators.

Only return active announcements that have been published. Applies only to requesting users that have permission to view unpublished items. Defaults to false for users with access to view unpublished items, otherwise true and unmodifiable.

Optional list of resources to include with the response. May include a string of the name of the resource. Possible values are: “sections”, “sections_user_count” if “sections” is passed, includes the course sections that are associated with the topic, if the topic is specific to sertain sections of the course. If “sections_user_count” is passed, then:

(a) If sections were asked for *and* the topic is specific to certain
    course sections sections, includes the number of users in each
    section. (as part of the section json asked for above)
(b) Else, includes at the root level the total number of users in the
    topic's context (group or course) that the topic applies to.

Defaults to “reservable”

Allowed values: reservable, manageable

Array of context codes used to limit returned results.

Defaults to false. If true, includes past appointment groups

Array of additional information to include.

“appointments”

calendar event time slots for this appointment group

“child_events”

reservations of those time slots

“participant_count”

number of reservations

“reserved_times”

the event id, start time and end time of reservations the current user has made)

“all_context_codes”

all context codes associated with this appointment group

Allowed values: appointments, child_events, participant_count, reserved_times, all_context_codes

Array of context codes (courses, e.g. course_1) this group should be linked to (1 or more). Users in the course(s) with appropriate permissions will be able to sign up for this appointment group.

Array of sub context codes (course sections or a single group category) this group should be linked to. Used to limit the appointment group to particular sections. If a group category is specified, students will sign up in groups and the participant_type will be “Group” instead of “User”.

Short title for the appointment group.

Longer text description of the appointment group.

Location name of the appointment group.

Location address.

Indicates whether this appointment group should be published (i.e. made available for signup). Once published, an appointment group cannot be unpublished. Defaults to false.

Maximum number of participants that may register for each time slot. Defaults to null (no limit).

Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots.

Maximum number of time slots a user may register for.

Nested array of start time/end time pairs indicating time slots for this appointment group. Refer to the example request.

“private”

participants cannot see who has signed up for a particular time slot

“protected”

participants can see who has signed up. Defaults to “private”.

Allowed values: private, protected

Array of additional information to include. See include[] argument of “List appointment groups” action.

“child_events”

reservations of time slots time slots

“appointments”

will always be returned

“all_context_codes”

all context codes associated with this appointment group

Allowed values: child_events, appointments, all_context_codes

Array of context codes (courses, e.g. course_1) this group should be linked to (1 or more). Users in the course(s) with appropriate permissions will be able to sign up for this appointment group.

Array of sub context codes (course sections or a single group category) this group should be linked to. Used to limit the appointment group to particular sections. If a group category is specified, students will sign up in groups and the participant_type will be “Group” instead of “User”.

Short title for the appointment group.

Longer text description of the appointment group.

Location name of the appointment group.

Location address.

Indicates whether this appointment group should be published (i.e. made available for signup). Once published, an appointment group cannot be unpublished. Defaults to false.

Maximum number of participants that may register for each time slot. Defaults to null (no limit).

Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots.

Maximum number of time slots a user may register for.

Nested array of start time/end time pairs indicating time slots for this appointment group. Refer to the example request.

“private”

participants cannot see who has signed up for a particular time slot

“protected”

participants can see who has signed up. Defaults to “private”.

Allowed values: private, protected

Reason for deleting/canceling the appointment group.

Limits results to the a given participation status, defaults to “all”

Allowed values: all, registered, registered

Limits results to the a given participation status, defaults to “all”

Allowed values: all, registered, registered

List of ids of appointment groups to search.

Associations to include with the group. “discussion_topic”, “all_dates” “assignment_visibility” & “submission” are only valid if “assignments” is also included. The “assignment_visibility” option additionally requires that the Differentiated Assignments course feature be turned on.

Allowed values: assignments, discussion_topic, all_dates, assignment_visibility, overrides, submission

If “assignments” are included, those with the specified submission types will be excluded from the assignment groups.

Allowed values: online_quiz, discussion_topic, wiki_page, external_tool

Apply assignment overrides for each assignment, defaults to true.

The id of the grading period in which assignment groups are being requested (Requires grading periods to exist.)

If true, all assignments returned will apply to the current user in the specified grading period. If assignments apply to other students in the specified grading period, but not the current user, they will not be returned. (Requires the grading_period_id argument and grading periods to exist. In addition, the current user must be a student.)

Associations to include with the group. “discussion_topic” and “assignment_visibility” and “submission” are only valid if “assignments” is also included. The “assignment_visibility” option additionally requires that the Differentiated Assignments course feature be turned on.

Allowed values: assignments, discussion_topic, assignment_visibility, submission

Apply assignment overrides for each assignment, defaults to true.

The id of the grading period in which assignment groups are being requested (Requires grading periods to exist on the account)

The assignment group's name

The position of this assignment group in relation to the other assignment groups

The percent of the total grade that this assignment group represents

The sis source id of the Assignment Group

The integration data of the Assignment Group

The grading rules that are applied within this assignment group See the Assignment Group object definition for format

The ID of an active Assignment Group to which the assignments that are currently assigned to the destroyed Assignment Group will be assigned. NOTE: If this argument is not provided, any assignments in this Assignment Group will be deleted.

Associations to include with the assignment. The “assignment_visibility” option requires that the Differentiated Assignments course feature be turned on. If “observed_users” is passed, submissions for observed users will also be included as an array.

Allowed values: submission, assignment_visibility, all_dates, overrides, observed_users

The partial title of the assignments to match and return.

Apply assignment overrides for each assignment, defaults to true.

Split up “needs_grading_count” by sections into the “needs_grading_count_by_section” key, defaults to false

If included, only return certain assignments depending on due date and submission status.

Allowed values: past, overdue, undated, ungraded, unsubmitted, upcoming, future

if set, return only assignments specified

Determines the order of the assignments. Defaults to “position”.

Allowed values: position, name

Associations to include with the assignment. The “assignment_visibility” option requires that the Differentiated Assignments course feature be turned on. If

Allowed values: submission, assignment_visibility, overrides, observed_users

Apply assignment overrides to the assignment, defaults to true.

Split up “needs_grading_count” by sections into the “needs_grading_count_by_section” key, defaults to false

All dates associated with the assignment, if applicable

The assignment name.

The position of this assignment in the group when displaying assignment lists.

List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element.

If not allowing online submissions, your options are:

"online_quiz"
"none"
"on_paper"
"discussion_topic"
"external_tool"

If you are allowing online submissions, you can have one or many allowed submission types:

"online_upload"
"online_text_entry"
"online_url"
"media_recording" (Only valid when the Kaltura plugin is enabled)

Allowed values: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording

Allowed extensions if submission_types includes “online_upload”

Example:

allowed_extensions: ["docx","ppt"]

Only applies when the Turnitin plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles Turnitin submissions for the assignment. Will be ignored if Turnitin is not available for the course.

Only applies when the VeriCite plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles VeriCite submissions for the assignment. Will be ignored if VeriCite is not available for the course.

Settings to send along to turnitin. See Assignment object definition for format.

Data used for SIS integrations. Requires admin-level token with the “Manage SIS” permission. JSON string required.

Unique ID from third party integrations

If submission_types does not include external_tool,discussion_topic, online_quiz, or on_paper, determines whether or not peer reviews will be turned on for the assignment.

Whether peer reviews will be assigned automatically by Canvas or if teachers must manually assign peer reviews. Does not apply if peer reviews are not enabled.

If true, Canvas will send a notification to students in the class notifying them that the content has changed.

If present, the assignment will become a group assignment assigned to the group.

If this is a group assignment, teachers have the options to grade students individually. If false, Canvas will apply the assignment's score to each member of the group. If true, the teacher can manually assign scores to each member of the group.

Hash of external tool parameters if submission_types is [“external_tool”]. See Assignment object definition for format.

The maximum points possible on the assignment.

The strategy used for grading the assignment. The assignment defaults to “points” if this field is omitted.

Allowed values: pass_fail, percent, letter_grade, gpa_scale, points

The day/time the assignment is due. Must be between the lock dates if there are lock dates. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The assignment's description, supports HTML.

The assignment group id to put the assignment in. Defaults to the top assignment group in the course.

Whether this assignment is muted. A muted assignment does not send change notifications and hides grades from students. Defaults to false.

List of overrides for the assignment.

Whether this assignment is only visible to overrides (Only useful if 'differentiated assignments' account setting is on)

Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course. This will update the grading_type for the course to 'letter_grade' unless it is already 'gpa_scale'.

Whether this assignment is counted towards a student's final grade.

Whether this assignment should use the Quizzes 2 LTI tool. Sets the submission type to 'external_tool' and configures the external tool attributes to use the Quizzes 2 LTI tool configured for this course. Has no effect if no Quizzes 2 LTI tool is configured.

Whether this assignment is moderated.

The assignment name.

The position of this assignment in the group when displaying assignment lists.

List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element.

If not allowing online submissions, your options are:

"online_quiz"
"none"
"on_paper"
"discussion_topic"
"external_tool"

If you are allowing online submissions, you can have one or many allowed submission types:

"online_upload"
"online_text_entry"
"online_url"
"media_recording" (Only valid when the Kaltura plugin is enabled)

Allowed values: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording

Allowed extensions if submission_types includes “online_upload”

Example:

allowed_extensions: ["docx","ppt"]

Only applies when the Turnitin plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles Turnitin submissions for the assignment. Will be ignored if Turnitin is not available for the course.

Only applies when the VeriCite plugin is enabled for a course and the submission_types array includes “online_upload”. Toggles VeriCite submissions for the assignment. Will be ignored if VeriCite is not available for the course.

Settings to send along to turnitin. See Assignment object definition for format.

Data used for SIS integrations. Requires admin-level token with the “Manage SIS” permission. JSON string required.

Unique ID from third party integrations

If submission_types does not include external_tool,discussion_topic, online_quiz, or on_paper, determines whether or not peer reviews will be turned on for the assignment.

Whether peer reviews will be assigned automatically by Canvas or if teachers must manually assign peer reviews. Does not apply if peer reviews are not enabled.

If true, Canvas will send a notification to students in the class notifying them that the content has changed.

If present, the assignment will become a group assignment assigned to the group.

If this is a group assignment, teachers have the options to grade students individually. If false, Canvas will apply the assignment's score to each member of the group. If true, the teacher can manually assign scores to each member of the group.

Hash of external tool parameters if submission_types is [“external_tool”]. See Assignment object definition for format.

The maximum points possible on the assignment.

The strategy used for grading the assignment. The assignment defaults to “points” if this field is omitted.

Allowed values: pass_fail, percent, letter_grade, gpa_scale, points

The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.

The assignment's description, supports HTML.

The assignment group id to put the assignment in. Defaults to the top assignment group in the course.

Whether this assignment is muted. A muted assignment does not send change notifications and hides grades from students. Defaults to false.

List of overrides for the assignment.

Whether this assignment is only visible to overrides (Only useful if 'differentiated assignments' account setting is on)

Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course. This will update the grading_type for the course to 'letter_grade' unless it is already 'gpa_scale'.

Whether this assignment is counted towards a student's final grade.

Whether this assignment is moderated.

The IDs of the override's target students. If present, the IDs must each identify a user with an active student enrollment in the course that is not already targetted by a different adhoc override.

The title of the adhoc assignment override. Required if student_ids is present, ignored otherwise (the title is set to the name of the targetted group or section instead).

The ID of the override's target group. If present, the following conditions must be met for the override to be successful:

1. the assignment MUST be a group assignment (a group_category_id is assigned to it)

2. the ID must identify an active group in the group set the assignment is in

3. the ID must not be targetted by a different override

See Appendix: Group assignments for more info.

The ID of the override's target section. If present, must identify an active section of the assignment's course not already targetted by a different override.

The day/time the overridden assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect due date. May be present but null to indicate the override removes any previous due date.

The day/time the overridden assignment becomes unlocked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the unlock date. May be present but null to indicate the override removes any previous unlock date.

The day/time the overridden assignment becomes locked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the lock date. May be present but null to indicate the override removes any previous lock date.

The IDs of the override's target students. If present, the IDs must each identify a user with an active student enrollment in the course that is not already targetted by a different adhoc override. Ignored unless the override being updated is adhoc.

The title of an adhoc assignment override. Ignored unless the override being updated is adhoc.

The day/time the overridden assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect due date. May be present but null to indicate the override removes any previous due date.

The day/time the overridden assignment becomes unlocked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the unlock date. May be present but null to indicate the override removes any previous unlock date.

The day/time the overridden assignment becomes locked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the lock date. May be present but null to indicate the override removes any previous lock date.

Ids of overrides to retrieve

Ids of assignments for each override

Attributes for the new assignment overrides. See Create an assignment override for available attributes

Attributes for the updated overrides.

The beginning of the time range from which you want events. Events are stored for one year.

The end of the time range from which you want events.

The beginning of the time range from which you want events. Events are stored for one year.

The end of the time range from which you want events.

The beginning of the time range from which you want events. Events are stored for one year.

The end of the time range from which you want events.

Courses to add as associated courses

Courses to remove as associated courses

An optional comment to be included in the sync history.

Send a notification to the calling user when the sync completes.

Whether course settings should be copied over to associated courses. Defaults to true for newly associated courses.

The type of the object.

Allowed values: assignment, attachment, discussion_topic, external_tool, quiz, wiki_page

The ID of the object.

Whether to apply restrictions.

(Optional) If the object is restricted, this specifies a set of restrictions. If not specified, the course-level restrictions will be used. See Course API update documentation

The name of the bookmark

The url of the bookmark

The position of the bookmark. Defaults to the bottom.

The data associated with the bookmark

The name of the bookmark

The url of the bookmark

The position of the bookmark. Defaults to the bottom.

The data associated with the bookmark

Defaults to “event”

Allowed values: event, assignment

Only return events since the start_date (inclusive). Defaults to today. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

Only return events before the end_date (inclusive). Defaults to start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date is the same as start_date, then only events on that day are returned.

Defaults to false (dated events only). If true, only return undated events and ignore start_date and end_date.

Defaults to false (uses start_date, end_date, and undated criteria). If true, all events are returned, ignoring start_date, end_date, and undated criteria.

List of context codes of courses/groups/users whose events you want to see. If not specified, defaults to the current user (i.e personal calendar, no course/group events). Limited to 10 context codes, additional ones are ignored. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42

Array of attributes to exclude. Possible values are “description”, “child_events” and “assignment”

Defaults to “event”

Allowed values: event, assignment

Only return events since the start_date (inclusive). Defaults to today. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

Only return events before the end_date (inclusive). Defaults to start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date is the same as start_date, then only events on that day are returned.

Defaults to false (dated events only). If true, only return undated events and ignore start_date and end_date.

Defaults to false (uses start_date, end_date, and undated criteria). If true, all events are returned, ignoring start_date, end_date, and undated criteria.

List of context codes of courses/groups/users whose events you want to see. If not specified, defaults to the current user (i.e personal calendar, no course/group events). Limited to 10 context codes, additional ones are ignored. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42

Array of attributes to exclude. Possible values are “description”, “child_events” and “assignment”

Context code of the course/group/user whose calendar this event should be added to.

Short title for the calendar event.

Longer HTML description of the event.

Start date/time of the event.

End date/time of the event.

Location name of the event.

Location address

Time zone of the user editing the event. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

When true event is considered to span the whole day and times are ignored.

Section-level start time(s) if this is a course event. X can be any identifier, provided that it is consistent across the start_at, end_at and context_code

Section-level end time(s) if this is a course event.

Context code(s) corresponding to the section-level start and end time(s).

Number of times to copy/duplicate the event. Count cannot exceed 200.

Defaults to 1 if duplicate `count` is set. The interval between the duplicated events.

Defaults to “weekly”. The frequency at which to duplicate the event

Allowed values: daily, weekly, monthly

Defaults to false. If set to `true`, an increasing counter number will be appended to the event title when the event is duplicated. (e.g. Event 1, Event 2, Event 3, etc)

User or group id for whom you are making the reservation (depends on the participant type). Defaults to the current user (or user's candidate group).

Comments to associate with this reservation

Defaults to false. If true, cancel any previous reservation(s) for this participant and appointment group.

Context code of the course/group/user to move this event to. Scheduler appointments and events with section-specific times cannot be moved between calendars.

Short title for the calendar event.

Longer HTML description of the event.

Start date/time of the event.

End date/time of the event.

Location name of the event.

Location address

Time zone of the user editing the event. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

When true event is considered to span the whole day and times are ignored.

Section-level start time(s) if this is a course event. X can be any identifier, provided that it is consistent across the start_at, end_at and context_code

Section-level end time(s) if this is a course event.

Context code(s) corresponding to the section-level start and end time(s).

Reason for deleting/canceling the event.

An array of timetable objects for the course section specified by course_section_id. If course_section_id is set to “all”, events will be created for the entire course.

A comma-separated list of abbreviated weekdays (Mon-Monday, Tue-Tuesday, Wed-Wednesday, Thu-Thursday, Fri-Friday, Sat-Saturday, Sun-Sunday)

Time to start each event at (e.g. “9:00 am”)

Time to end each event at (e.g. “9:00 am”)

A location name to set for each event

Events will be created for the course section specified by course_section_id. If not present, events will be created for the entire course.

An array of event objects to use.

Start time for the event

End time for the event

Location name for the event

A unique identifier that can be used to update the event at a later time If one is not specified, an identifier will be generated based on the start and end times

• “collaborator_lti_id”: Optional information to include with each member. Represents an identifier to be used for the member in an LTI context.

• “avatar_image_url”: Optional information to include with each member. The url for the avatar of a collaborator with type 'user'.

Allowed values: collaborator_lti_id, avatar_image_url

The user id for whom you want to retrieve CommMessages

The beginning of the time range you want to retrieve message from.

The end of the time range you want to retrieve messages for.

An email address or SMS number. Not required for “push” type channels.

The type of communication channel.

In order to enable push notification support, the server must be properly configured (via sns.yml) to communicate with Amazon Simple Notification Services, and the developer key used to create the access token from this request must have an SNS ARN configured on it.

Allowed values: email, sms, push

A registration id, device token, or equivalent token given to an app when registering with a push notification provider. Only valid for “push” type channels.

Only valid for site admins and account admins making requests; If true, the channel is automatically validated and no confirmation email or SMS is sent. Otherwise, the user must respond to a confirmation message to confirm the channel.

“common_cartridge”

Export the contents of the course in the Common Cartridge (.imscc) format

“qti”

Export quizzes from a course in the QTI format

“zip”

Export files from a course, group, or user in a zip file

Allowed values: common_cartridge, qti, zip

Don't send the notifications about the export to the user. Default: false

The select parameter allows exporting specific data. The keys are object types like 'files', 'folders', 'pages', etc. The value for each key is a list of object ids. An id can be an integer or a string.

Multiple object types can be selected in the same call. However, not all object types are valid for every export_type. Common Cartridge supports all object types. Zip and QTI only support the object types as described below.

“folders”

Also supported for zip export_type.

“files”

Also supported for zip export_type.

“quizzes”

Also supported for qti export_type.

Allowed values: folders, files, attachments, quizzes, assignments, announcements, calendar_events, discussion_topics, modules, module_items, pages, rubrics

Set the workflow_state of the issue.

Allowed values: active, resolved

The type of the migration. Use the Migrator endpoint to see all available migrators. Default allowed values: canvas_cartridge_importer, common_cartridge_importer, course_copy_importer, zip_file_importer, qti_converter, moodle_converter

Required if uploading a file. This is the first step in uploading a file to the content migration. See the File Upload Documentation for details on the file upload workflow.

Other file upload properties, See File Upload Documentation

A URL to download the file from. Must not require authentication.

The course to copy from for a course copy migration. (required if doing course copy)

The folder to unzip the .zip file into for a zip_file_import.

Whether to overwrite quizzes with the same identifiers between content packages.

The existing question bank ID to import questions into if not specified in the content package.

The question bank to import questions into if not specified in the content package, if both bank id and name are set, id will take precedence.

Whether to shift dates in the copied course

The original start date of the source content/course

The original end date of the source content/course

The new start date for the content/course

The new end date for the source content/course

Move anything scheduled for day 'X' to the specified day. (0-Sunday, 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday)

Whether to remove dates in the copied course. Cannot be used in conjunction with shift_dates.

When set, only return conversations of the specified type. For example, set to “unread” to return only conversations that haven't been read. The default behavior is to return all non-archived conversations (i.e. read and unread).

Allowed values: unread, starred, archived

When set, only return conversations for the specified courses, groups or users. The id should be prefixed with its type, e.g. “user_123” or “course_456”. Can be an array (by setting “filter[]”) or single value (by setting “filter”)

When filter[] contains multiple filters, combine them with this mode, filtering conversations that at have at least all of the contexts (“and”) or at least one of the contexts (“or”)

Allowed values: and, or, default or

(Obsolete) Submissions are no longer linked to conversations. This parameter is ignored.

Default is false. If true, the top-level element of the response will be an object rather than an array, and will have the keys “conversations” which will contain the paged conversation data, and “conversation_ids” which will contain the ids of all conversations under this scope/filter in the same order.

“participant_avatars”

Optionally include an “avatar_url” key for each user participanting in the conversation

Allowed values: participant_avatars

An array of recipient ids. These may be user ids or course/group ids prefixed with “course_” or “group_” respectively, e.g. recipients[]=1&recipients=2&recipients[]=course_3

The subject of the conversation. This is ignored when reusing a conversation. Maximum length is 255 characters.

The message to be sent

Defaults to false. If true, this will be a group conversation (i.e. all recipients may see all messages and replies). If false, individual private conversations will be started with each recipient. Must be set false if the number of recipients is over the set maximum (default is 100).

An array of attachments ids. These must be files that have been previously uploaded to the sender's “conversation attachments” folder.

Media comment id of an audio of video file to be associated with this message.

Type of the associated media file

Allowed values: audio, video

Will add a faculty journal entry for each recipient as long as the user making the api call has permission, the recipient is a student and faculty journals are enabled in the account.

Determines whether the messages will be created/sent synchronously or asynchronously. Defaults to sync, and this option is ignored if this is a group conversation or there is just one recipient (i.e. it must be a bulk private message). When sent async, the response will be an empty array (batch status can be queried via the batches API)

Allowed values: sync, async

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: unread, starred, archived

Used when generating “visible” in the API response. See the explanation under the index API action

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: and, or, default or

The course or group that is the context for this conversation. Same format as courses or groups in the recipients argument.

(Obsolete) Submissions are no longer linked to conversations. This parameter is ignored.

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: unread, starred, archived

Used when generating “visible” in the API response. See the explanation under the index API action

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: and, or, default or

Default true. If true, unread conversations will be automatically marked as read. This will default to false in a future API release, so clients should explicitly send true if that is the desired behavior.

Change the state of this conversation

Allowed values: read, unread, archived

Toggle the current user's subscription to the conversation (only valid for group conversations). If unsubscribed, the user will still have access to the latest messages, but the conversation won't be automatically flagged as unread, nor will it jump to the top of the inbox.

Toggle the starred state of the current user's view of the conversation.

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: unread, starred, archived

Used when generating “visible” in the API response. See the explanation under the index API action

Used when generating “visible” in the API response. See the explanation under the index API action

Allowed values: and, or, default or

An array of recipient ids. These may be user ids or course/group ids prefixed with “course_” or “group_” respectively, e.g. recipients[]=1&recipients=2&recipients[]=course_3

The message to be sent.

An array of attachments ids. These must be files that have been previously uploaded to the sender's “conversation attachments” folder.

Media comment id of an audio of video file to be associated with this message.

Type of the associated media file.

Allowed values: audio, video

no description

no description

Will add a faculty journal entry for each recipient as long as the user making the api call has permission, the recipient is a student and faculty journals are enabled in the account.

Array of message ids to be deleted

List of conversations to update. Limited to 500 conversations.

The action to take on each conversation.

Allowed values: mark_as_read, mark_as_unread, star, unstar, archive, destroy

The beginning of the time range from which you want events.

The end of the time range from which you want events.

The ID of the user we want to add quiz extensions for.

Number of times the student is allowed to re-take the quiz over the multiple-attempt limit. This is limited to 1000 attempts or less.

The number of extra minutes to allow for all attempts. This will add to the existing time limit on the submission. This is limited to 10080 minutes (1 week)

Allow the student to take the quiz even if it's locked for everyone else.

The number of minutes to extend the quiz from the current time. This is mutually exclusive to extend_from_end_at. This is limited to 1440 minutes (24 hours)

The number of minutes to extend the quiz beyond the quiz's current ending time. This is mutually exclusive to extend_from_now. This is limited to 1440 minutes (24 hours)

When set, only return courses where the user is enrolled as this type. For example, set to “teacher” to return only courses where the user is enrolled as a Teacher. This argument is ignored if enrollment_role is given.

Allowed values: teacher, student, ta, observer, designer

Deprecated When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the Add Role API or a base role type of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the Add Role API or a built_in role type of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides.

Allowed values: active, invited_or_pending, completed

When set, only return courses that are not configured as blueprint courses.

• “needs_grading_count”: Optional information to include with each Course. When needs_grading_count is given, and the current user has grading rights, the total number of submissions needing grading for all assignments is returned.

• “syllabus_body”: Optional information to include with each Course. When syllabus_body is given the user-generated html for the course syllabus is returned.

• “public_description”: Optional information to include with each Course. When public_description is given the user-generated text for the course public description is returned.

• “total_scores”: Optional information to include with each Course. When total_scores is given, any student enrollments will also include the fields 'computed_current_score', 'computed_final_score', 'computed_current_grade', and 'computed_final_grade', as well as (if the user has permission) 'unposted_current_score', 'unposted_final_score', 'unposted_current_grade', and 'unposted_final_grade' (see Enrollment documentation for more information on these fields). This argument is ignored if the course is configured to hide final grades.

• “current_grading_period_scores”: Optional information to include with each Course. When current_grading_period_scores is given and total_scores is given, any student enrollments will also include the fields 'has_grading_periods', 'totals_for_all_grading_periods_option', 'current_grading_period_title', 'current_grading_period_id', current_period_computed_current_score', 'current_period_computed_final_score', 'current_period_computed_current_grade', and 'current_period_computed_final_grade', as well as (if the user has permission) 'current_period_unposted_current_score', 'current_period_unposted_final_score', 'current_period_unposted_current_grade', and 'current_period_unposted_final_grade' (see Enrollment documentation for more information on these fields). In addition, when this argument is passed, the course will have a 'has_grading_periods' attribute on it. This argument is ignored if the course is configured to hide final grades or if the total_scores argument is not included.

• “term”: Optional information to include with each Course. When term is given, the information for the enrollment term for each course is returned.

• “account”: Optional information to include with each Course. When account is given, the account json for each course is returned.

• “course_progress”: Optional information to include with each Course. When course_progress is given, each course will include a 'course_progress' object with the fields: 'requirement_count', an integer specifying the total number of requirements in the course, 'requirement_completed_count', an integer specifying the total number of requirements in this course that have been completed, and 'next_requirement_url', a string url to the next requirement item, and 'completed_at', the date the course was completed (null if incomplete). 'next_requirement_url' will be null if all requirements have been completed or the current module does not require sequential progress. “course_progress” will return an error message if the course is not module based or the user is not enrolled as a student in the course.

• “sections”: Section enrollment information to include with each Course. Returns an array of hashes containing the section ID (id), section name (name), start and end dates (start_at, end_at), as well as the enrollment type (enrollment_role, e.g. 'StudentEnrollment').

• “storage_quota_used_mb”: The amount of storage space used by the files in this course

• “total_students”: Optional information to include with each Course. Returns an integer for the total amount of active and invited students.

• “passback_status”: Include the grade passback_status

• “favorites”: Optional information to include with each Course. Indicates if the user has marked the course as a favorite course.

• “teachers”: Teacher information to include with each Course. Returns an array of hashes containing the UserDisplay information for each teacher in the course.

• “observed_users”: Optional information to include with each Course. Will include data for observed users if the current user has an observer enrollment.

• “tabs”: Optional information to include with each Course. Will include the list of tabs configured for each course. See the List available tabs API for more information.

• “course_image”: Optional course image data for when there is a course image and the course image feature flag has been enabled

Allowed values: needs_grading_count, syllabus_body, public_description, total_scores, current_grading_period_scores, term, account, course_progress, sections, storage_quota_used_mb, total_students, passback_status, favorites, teachers, observed_users, course_image

If set, only return courses that are in the given state(s). By default, “available” is returned for students and observers, and anything except “deleted”, for all other enrollment types

Allowed values: unpublished, available, completed, deleted

• “needs_grading_count”: Optional information to include with each Course. When needs_grading_count is given, and the current user has grading rights, the total number of submissions needing grading for all assignments is returned.

• “syllabus_body”: Optional information to include with each Course. When syllabus_body is given the user-generated html for the course syllabus is returned.

• “public_description”: Optional information to include with each Course. When public_description is given the user-generated text for the course public description is returned.

• “total_scores”: Optional information to include with each Course. When total_scores is given, any student enrollments will also include the fields 'computed_current_score', 'computed_final_score', 'computed_current_grade', and 'computed_final_grade' (see Enrollment documentation for more information on these fields). This argument is ignored if the course is configured to hide final grades.

• “current_grading_period_scores”: Optional information to include with each Course. When current_grading_period_scores is given and total_scores is given, any student enrollments will also include the fields 'has_grading_periods', 'totals_for_all_grading_periods_option', 'current_grading_period_title', 'current_grading_period_id', current_period_computed_current_score', 'current_period_computed_final_score', 'current_period_computed_current_grade', and 'current_period_computed_final_grade', as well as (if the user has permission) 'current_period_unposted_current_score', 'current_period_unposted_final_score', 'current_period_unposted_current_grade', and 'current_period_unposted_final_grade' (see Enrollment documentation for more information on these fields). In addition, when this argument is passed, the course will have a 'has_grading_periods' attribute on it. This argument is ignored if the course is configured to hide final grades or if the total_scores argument is not included.

• “term”: Optional information to include with each Course. When term is given, the information for the enrollment term for each course is returned.

• “account”: Optional information to include with each Course. When account is given, the account json for each course is returned.

• “course_progress”: Optional information to include with each Course. When course_progress is given, each course will include a 'course_progress' object with the fields: 'requirement_count', an integer specifying the total number of requirements in the course, 'requirement_completed_count', an integer specifying the total number of requirements in this course that have been completed, and 'next_requirement_url', a string url to the next requirement item, and 'completed_at', the date the course was completed (null if incomplete). 'next_requirement_url' will be null if all requirements have been completed or the current module does not require sequential progress. “course_progress” will return an error message if the course is not module based or the user is not enrolled as a student in the course.

• “sections”: Section enrollment information to include with each Course. Returns an array of hashes containing the section ID (id), section name (name), start and end dates (start_at, end_at), as well as the enrollment type (enrollment_role, e.g. 'StudentEnrollment').

• “storage_quota_used_mb”: The amount of storage space used by the files in this course

• “total_students”: Optional information to include with each Course. Returns an integer for the total amount of active and invited students.

• “passback_status”: Include the grade passback_status

• “favorites”: Optional information to include with each Course. Indicates if the user has marked the course as a favorite course.

• “teachers”: Teacher information to include with each Course. Returns an array of hashes containing the UserDisplay information for each teacher in the course.

• “observed_users”: Optional information to include with each Course. Will include data for observed users if the current user has an observer enrollment.

• “tabs”: Optional information to include with each Course. Will include the list of tabs configured for each course. See the List available tabs API for more information.

• “course_image”: Optional course image data for when there is a course image and the course image feature flag has been enabled

Allowed values: needs_grading_count, syllabus_body, public_description, total_scores, current_grading_period_scores, term, account, course_progress, sections, storage_quota_used_mb, total_students, passback_status, favorites, teachers, observed_users, course_image

If set, only return courses that are in the given state(s). By default, “available” is returned for students and observers, and anything except “deleted”, for all other enrollment types

Allowed values: unpublished, available, completed, deleted

When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides.

Allowed values: active, invited_or_pending, completed

The name of the course. If omitted, the course will be named “Unnamed Course.”

The course code for the course.

Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z

Course end date in ISO8601 format. e.g. 2011-01-01T01:00Z

The name of the licensing. Should be one of the following abbreviations (a descriptive name is included in parenthesis for reference):

• 'private' (Private Copyrighted)

• 'cc_by_nc_nd' (CC Attribution Non-Commercial No Derivatives)

• 'cc_by_nc_sa' (CC Attribution Non-Commercial Share Alike)

• 'cc_by_nc' (CC Attribution Non-Commercial)

• 'cc_by_nd' (CC Attribution No Derivatives)

• 'cc_by_sa' (CC Attribution Share Alike)

• 'cc_by' (CC Attribution)

• 'public_domain' (Public Domain).

Set to true if course is public to both authenticated and unauthenticated users.

Set to true if course is public only to authenticated users.

Set to true to make the course syllabus public.

Set to true to make the course syllabus public for authenticated users.

A publicly visible description of the course.

If true, students will be able to modify the course wiki.

If true, course members will be able to comment on wiki pages.

If true, students can attach files to forum posts.

Set to true if the course is open enrollment.

Set to true if the course is self enrollment.

Set to true to restrict user enrollments to the start and end dates of the course.

The unique ID of the term to create to course in.

The unique SIS identifier.

The unique Integration identifier.

If this option is set to true, the totals in student grades summary will be hidden.

Set to true to weight final grade based on assignment groups percentages.

The time zone for the course. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

If this option is set to true, the course will be available to students immediately.

Set to true to enroll the current user as the teacher.

The type of page that users will see when they first visit the course

• 'feed' Recent Activity Dashboard

• 'modules' Course Modules/Sections Page

• 'assignments' Course Assignments List

• 'syllabus' Course Syllabus Page

other types may be added in the future

Allowed values: feed, wiki, modules, syllabus, assignments

The syllabus body for the course

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course.

Optional. Specifies the format of the course. (Should be 'on_campus', 'online', or 'blended')

When true, will first try to re-activate a deleted course with matching sis_course_id if possible.

The partial name or full ID of the users to match and return in the results list.

When set, only return users where the user is enrolled as this type. “student_view” implies include[]=test_student. This argument is ignored if enrollment_role is given.

Allowed values: teacher, student, student_view, ta, observer, designer

Deprecated When set, only return users enrolled with the specified course-level role. This can be a role created with the Add Role API or a base role type of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the Add Role API or a built_in role id with type 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

• “email”: Optional user email.

• “enrollments”:

Optionally include with each Course the user's current and invited enrollments. If the user is enrolled as a student, and the account has permission to manage or view all grades, each enrollment will include a 'grades' key with 'current_score', 'final_score', 'current_grade' and 'final_grade' values.

• “locked”: Optionally include whether an enrollment is locked.

• “avatar_url”: Optionally include avatar_url.

• “bio”: Optionally include each user's bio.

• “test_student”: Optionally include the course's Test Student,

if present. Default is to not include Test Student.

• “custom_links”: Optionally include plugin-supplied custom links for each student,

such as analytics information

• “current_grading_period_scores”: if enrollments is included as

well as this directive, the scores returned in the enrollment will be for the current grading period if there is one. A 'grading_period_id' value will also be included with the scores. if grading_period_id is nil there is no current grading period and the score is a total score.

Allowed values: email, enrollments, locked, avatar_url, test_student, bio, custom_links, current_grading_period_scores

If this parameter is given and it corresponds to a user in the course, the page parameter will be ignored and the page containing the specified user will be returned instead.

If included, the course users set will only include users with IDs specified by the param. Note: this will not work in conjunction with the “user_id” argument but multiple user_ids can be included.

When set, only return users where the enrollment workflow state is of one of the given types. “active” and “invited” enrollments are returned by default.

Allowed values: active, invited, rejected, completed, inactive

The html content to process

The action to take on the course.

Allowed values: delete, conclude

Let students create discussion topics

Let students attach files to discussions

Let students edit or delete their own discussion posts

Let students organize their own groups

Hide totals in student grades summary

Hide grade distribution graphs from students

Disable comments on announcements

Restrict students from viewing courses after end date

Restrict students from viewing courses before start date

Show the most recent announcements on the Course home page (if a Wiki, defaults to five announcements, configurable via home_page_announcement_limit)

Limit the number of announcements on the home page if enabled via show_announcements_on_home_page

• “all_courses”: Also search recently deleted courses.

• “permissions”: Include permissions the current user has for the course.

• “observed_users”: include observed users in the enrollments

• “course_image”: Optional course image data for when there is a course image and the course image feature flag has been enabled

Allowed values: needs_grading_count, syllabus_body, public_description, total_scores, current_grading_period_scores, term, account, course_progress, sections, storage_quota_used_mb, total_students, passback_status, favorites, teachers, observed_users, all_courses, permissions, observed_users, course_image

The unique ID of the account to move the course to.

The name of the course. If omitted, the course will be named “Unnamed Course.”

The course code for the course.

Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z

Course end date in ISO8601 format. e.g. 2011-01-01T01:00Z

The name of the licensing. Should be one of the following abbreviations (a descriptive name is included in parenthesis for reference):

• 'private' (Private Copyrighted)

• 'cc_by_nc_nd' (CC Attribution Non-Commercial No Derivatives)

• 'cc_by_nc_sa' (CC Attribution Non-Commercial Share Alike)

• 'cc_by_nc' (CC Attribution Non-Commercial)

• 'cc_by_nd' (CC Attribution No Derivatives)

• 'cc_by_sa' (CC Attribution Share Alike)

• 'cc_by' (CC Attribution)

• 'public_domain' (Public Domain).

Set to true if course is public to both authenticated and unauthenticated users.

Set to true if course is public only to authenticated users.

Set to true to make the course syllabus public.

Set to true to make the course syllabus to public for authenticated users.

A publicly visible description of the course.

If true, students will be able to modify the course wiki.

If true, course members will be able to comment on wiki pages.

If true, students can attach files to forum posts.

Set to true if the course is open enrollment.

Set to true if the course is self enrollment.

Set to true to restrict user enrollments to the start and end dates of the course.

The unique ID of the term to create to course in.

The unique SIS identifier.

The unique Integration identifier.

If this option is set to true, the totals in student grades summary will be hidden.

The time zone for the course. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

Set to true to weight final grade based on assignment groups percentages.

Set the storage quota for the course, in megabytes. The caller must have the “Manage storage quotas” account permission.

If this option is set to true, the course will be available to students immediately.

The action to take on each course.

• 'claim' makes a course no longer visible to students. This action is also called “unpublish” on the web site. A course cannot be unpublished if students have received graded submissions.

• 'offer' makes a course visible to students. This action is also called “publish” on the web site.

• 'conclude' prevents future enrollments and makes a course read-only for all participants. The course still appears in prior-enrollment lists.

• 'delete' completely removes the course from the web site (including course menus and prior-enrollment lists). All enrollments are deleted. Course content may be physically deleted at a future date.

• 'undelete' attempts to recover a course that has been deleted. (Recovery is not guaranteed; please conclude rather than delete a course if there is any possibility the course will be used again.) The recovered course will be unpublished. Deleted enrollments will not be recovered.

Allowed values: claim, offer, conclude, delete, undelete

The type of page that users will see when they first visit the course

• 'feed' Recent Activity Dashboard

• 'wiki' Wiki Front Page

• 'modules' Course Modules/Sections Page

• 'assignments' Course Assignments List

• 'syllabus' Course Syllabus Page

other types may be added in the future

Allowed values: feed, wiki, modules, syllabus, assignments

The syllabus body for the course

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course.

Optional. Specifies the format of the course. (Should be either 'on_campus' or 'online')

This is a file ID corresponding to an image file in the course that will be used as the course image. This will clear the course's image_url setting if set. If you attempt to provide image_url and image_id in a request it will fail.

This is a URL to an image to be used as the course image. This will clear the course's image_id setting if set. If you attempt to provide image_url and image_id in a request it will fail.

If this option is set to true, the course image url and course image ID are both set to nil

Sets the course as a blueprint course. NOTE: The Blueprint Courses feature is in beta

Sets a default set to apply to blueprint course objects when restricted, unless use_blueprint_restrictions_by_object_type is enabled. See the Blueprint Restriction documentation

When enabled, the blueprint_restrictions parameter will be ignored in favor of the blueprint_restrictions_by_object_type parameter

Allows setting multiple Blueprint Restriction to apply to blueprint course objects of the matching type when restricted. The possible object types are “assignment”, “attachment”, “discussion_topic”, “quiz” and “wiki_page”. Example usage:

course[blueprint_restrictions_by_object_type][assignment][content]=1

List of ids of courses to update. At most 500 courses may be updated in one call.

no description

Allowed values: offer, conclude, delete, undelete

no description

List of permissions to check against the authenticated user. Permission names are documented in the Create a role endpoint.

ID or SIS-ID of the course to copy the content from

A list of the course content types to exclude, all areas not listed will be copied.

Allowed values: course_settings, assignments, external_tools, files, topics, calendar_events, quizzes, wiki_pages, modules, outcomes

A list of the course content types to copy, all areas not listed will not be copied.

Allowed values: course_settings, assignments, external_tools, files, topics, calendar_events, quizzes, wiki_pages, modules, outcomes

Include hidden parameters (defaults to false)

no description

The position of the column relative to other custom columns

Hidden columns are not displayed in the gradebook

Set this if the column is created by a teacher. The gradebook only supports one teacher_notes column.

Set this to prevent the column from being editable in the gradebook ui

no description

If true, hidden columns will be included in the result. If false or absent, only visible columns will be returned.

Column content. Setting this to blank will delete the datum object.

If “all_dates” is passed, all dates associated with graded discussions' assignments will be included. if “sections” is passed, includes the course sections that are associated with the topic, if the topic is specific to certain sections of the course. If “sections_user_count” is passed, then:

(a) If sections were asked for *and* the topic is specific to certain
    course sections, includes the number of users in each
    section. (as part of the section json asked for above)
(b) Else, includes at the root level the total number of users in the
    topic's context (group or course) that the topic applies to.

If “overrides” is passed, the overrides for the assignment will be included

Allowed values: all_dates, sections, sections_user_count, overrides

Determines the order of the discussion topic list. Defaults to “position”.

Allowed values: position, recent_activity, title

Only return discussion topics in the given state(s). Defaults to including all topics. Filtering is done after pagination, so pages may be smaller than requested if topics are filtered. Can pass multiple states as comma separated string.

Allowed values: locked, unlocked, pinned, unpinned

Return announcements instead of discussion topics. Defaults to false

The state of the discussion topic to return. Currently only supports unread state.

Allowed values: all, unread

The partial title of the discussion topics to match and return.

For students, exclude topics that are locked by module progression. Defaults to false.

no description

no description

The type of discussion. Defaults to side_comment if not value is given. Accepted values are 'side_comment', for discussions that only allow one level of nested comments, and 'threaded' for fully threaded discussions.

Allowed values: side_comment, threaded

Whether this topic is published (true) or draft state (false). Only teachers and TAs have the ability to create draft state topics.

If a timestamp is given, the topic will not be published until that time.

Whether or not users can rate entries in this topic.

If a timestamp is given, the topic will be scheduled to lock at the provided timestamp. If the timestamp is in the past, the topic will be locked.

If true, the topic will have an associated podcast feed.

If true, the podcast will include posts from students as well. Implies podcast_enabled.

If true then a user may not respond to other replies until that user has made an initial reply. Defaults to false.

To create an assignment discussion, pass the assignment parameters as a sub-object. See the Create an Assignment API for the available parameters. The name parameter will be ignored, as it's taken from the discussion title. If you want to make a discussion that was an assignment NOT an assignment, pass set_assignment = false as part of the assignment object

If true, this topic is an announcement. It will appear in the announcement's section rather than the discussions section. This requires announcment-posting permissions.

If true, this topic will be listed in the “Pinned Discussion” section

By default, discussions are sorted chronologically by creation date, you can pass the id of another topic to have this one show up after the other when they are listed.

If present, the topic will become a group discussion assigned to the group.

If true, only graders will be allowed to rate entries.

If true, entries will be sorted by rating.

A multipart/form-data form-field-style attachment. Attachments larger than 1 kilobyte are subject to quota restrictions.

A comma-separated list of sections ids to which the discussion topic should be made specific too. If it is not desired to make the discussion topic specific to sections, then this parameter may be omitted or set to “all”. Can only be present only on announcements and only those that are for a course (as opposed to a group).

no description

no description

The type of discussion. Defaults to side_comment if not value is given. Accepted values are 'side_comment', for discussions that only allow one level of nested comments, and 'threaded' for fully threaded discussions.

Allowed values: side_comment, threaded

Whether this topic is published (true) or draft state (false). Only teachers and TAs have the ability to create draft state topics.

If a timestamp is given, the topic will not be published until that time.

If a timestamp is given, the topic will be scheduled to lock at the provided timestamp. If the timestamp is in the past, the topic will be locked.

If true, the topic will have an associated podcast feed.

If true, the podcast will include posts from students as well. Implies podcast_enabled.

If true then a user may not respond to other replies until that user has made an initial reply. Defaults to false.

To create an assignment discussion, pass the assignment parameters as a sub-object. See the Create an Assignment API for the available parameters. The name parameter will be ignored, as it's taken from the discussion title. If you want to make a discussion that was an assignment NOT an assignment, pass set_assignment = false as part of the assignment object

If true, this topic is an announcement. It will appear in the announcement's section rather than the discussions section. This requires announcment-posting permissions.

If true, this topic will be listed in the “Pinned Discussion” section

By default, discussions are sorted chronologically by creation date, you can pass the id of another topic to have this one show up after the other when they are listed.

If present, the topic will become a group discussion assigned to the group.

If true, users will be allowed to rate entries.

If true, only graders will be allowed to rate entries.

If true, entries will be sorted by rating.

A comma-separated list of sections ids to which the discussion topic should be made specific too. If it is not desired to make the discussion topic specific to sections, then this parameter may be omitted or set to “all”. Can only be present only on announcements and only those that are for a course (as opposed to a group).

The ids of the pinned discussion topics in the desired order. (For example, “order=104,102,103”.)

The updated body of the entry.

If “all_dates” is passed, all dates associated with graded discussions' assignments will be included. if “sections” is passed, includes the course sections that are associated with the topic, if the topic is specific to certain sections of the course. If “sections_user_count” is passed, then: