Method: courses.courseWork.modifyAssignees

Modifies assignee mode and options of a coursework.

Only a teacher of the course that contains the coursework may call this method.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course or course work or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course or course work does not exist.

HTTP request

POST https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{id}:modifyAssignees

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
courseId

string

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

id

string

Identifier of the coursework.

Request body

The request body contains data with the following structure:

JSON representation
{
  "assigneeMode": enum(AssigneeMode),
  "modifyIndividualStudentsOptions": {
    object(ModifyIndividualStudentsOptions)
  }
}
Fields
assigneeMode

enum(AssigneeMode)

Mode of the coursework describing whether it will be assigned to all students or specified individual students.

modifyIndividualStudentsOptions

object(ModifyIndividualStudentsOptions)

Set which students are assigned or not assigned to the coursework. Must be specified only when assigneeMode is INDIVIDUAL_STUDENTS.

Response body

If successful, the response body contains an instance of CourseWork.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/classroom.coursework.students

For more information, see the OAuth 2.0 Overview.

Try it!

Send feedback about...

Classroom API
Classroom API
Need help? Visit our support page.