Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.announcements.addOnAttachments.patch
Stay organized with collections
Save and categorize content based on your preferences.
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}/announcements/{itemId}/addOnAttachments/{attachmentId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Required. Identifier of the course.
|
itemId |
string
Identifier of the post under which the attachment is attached.
|
attachmentId |
string
Required. Identifier of the attachment.
|
Query parameters
| Parameters |
postId |
string
Required. 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:
titleteacherViewUristudentViewUristudentWorkReviewUridueDatedueTimemaxPoints 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.announcements.addOnAttachments.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nUpdates an add-on attachment.\n\nRequires the add-on to have been the original creator of the attachment.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `itemId` | `string` Identifier of the post under which the attachment is attached. |\n| `attachmentId` | `string` Required. Identifier of the attachment. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` | `string` Required. Identifier of the post under which the attachment is attached. |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [AddOnAttachment](/workspace/classroom/reference/rest/v1/courses.announcements.addOnAttachments#AddOnAttachment).\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnAttachment](/workspace/classroom/reference/rest/v1/courses.announcements.addOnAttachments#AddOnAttachment).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
