Method: courses.posts.addOnAttachments.patch

Updates an add-on attachment.

Requires the add-on to have been the original creator of the attachment.

This method returns the following error codes:

  • PERMISSION_DENIED for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if one of the identified resources does not exist.

HTTP request

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
courseId

string

Required. Identifier of the course.
postId

string

Required. Identifier of the post under which the attachment is attached.
attachmentId

string

Required. Identifier of the attachment.

Query parameters

Parameters
itemId

string

Identifier of the post under which the attachment is attached.
updateMask

string (FieldMask format)

Required. Mask that identifies which fields on the attachment to 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 AddOnAttachment object. If a field that does not support empty values is included in the update mask and not set in the AddOnAttachment object, an INVALID_ARGUMENT error is returned.

The following fields may be specified by teachers:

  • title
  • teacherViewUri
  • studentViewUri
  • studentWorkReviewUri
  • dueDate
  • dueTime
  • maxPoints

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

Request body

The request body contains an instance of AddOnAttachment.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/classroom.addons.teacher

For more information, see the Authorization guide.