Method: courses.courseWork.patch

Updates one or more fields of a course work.

See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • FAILED_PRECONDITION if the requested course work has already been deleted.
  • NOT_FOUND if the requested course or course work does not exist.

HTTP request

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

The URL uses gRPC Transcoding 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 course work.

Query parameters

Parameters
updateMask

string (FieldMask format)

Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an INVALID_ARGUMENT error is returned.

The following fields may be specified by teachers:

  • title
  • description
  • state
  • dueDate
  • dueTime
  • maxPoints
  • scheduledTime
  • submissionModificationMode
  • topicId
  • gradingPeriodId

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

enum (PreviewVersion)

Optional. The preview version of the API. 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 CourseWork.

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 Authorization guide.