Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.courseWork.addOnAttachments.studentSubmissions.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates data associated with an add-on attachment submission.
Requires the add-on to have been the original creator of the attachment and the attachment to have a positive maxPoints value set.
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}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Required. Identifier of the course.
|
itemId |
string
Identifier of the Announcement, CourseWork, or CourseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId.
|
attachmentId |
string
Required. Identifier of the attachment.
|
submissionId |
string
Required. Identifier of the student's submission.
|
Query parameters
| Parameters |
postId
(deprecated) |
string
Optional. Deprecated, use itemId instead.
|
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 AddOnAttachmentStudentSubmission object. The following fields may be specified by teachers:
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 AddOnAttachmentStudentSubmission.
Response body
If successful, the response body contains an instance of AddOnAttachmentStudentSubmission.
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.courseWork.addOnAttachments.studentSubmissions.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 data associated with an add-on attachment submission.\n\nRequires the add-on to have been the original creator of the attachment and the attachment to have a positive `maxPoints` value set.\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}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}`\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 `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId. |\n| `attachmentId` | `string` Required. Identifier of the attachment. |\n| `submissionId` | `string` Required. Identifier of the student's submission. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\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 `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: - `pointsEarned` 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 [AddOnAttachmentStudentSubmission](/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments.studentSubmissions#AddOnAttachmentStudentSubmission).\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnAttachmentStudentSubmission](/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments.studentSubmissions#AddOnAttachmentStudentSubmission).\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)."]]
