Method: courses.studentGroups.patch

Updates one or more fields in a student group.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to modify the requested student group or for access errors.
  • NOT_FOUND if the student group does not exist or the user does not have access to the student group.
  • INVALID_ARGUMENT if invalid fields are specified in the update mask or if no update mask is supplied.

HTTP request

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Required. Identifier of the course.
id

string

Required. Identifier of the student group.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified.

The following fields can be specified by teachers:

  • title

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
previewVersion

enum (PreviewVersion)

Optional. The endpoint preview version. This must be set in order to access new API capabilities made available to developers in the Preview Program.

Request body

The request body contains an instance of StudentGroup.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/classroom.rosters

For more information, see the Authorization guide.