Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.topics.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates one or more fields of a topic.
This method returns the following error codes:
PERMISSION_DENIED if the requesting developer project did not create the corresponding topic or for access errors.INVALID_ARGUMENT if the request is malformed.FAILED_PRECONDITION if there exists a topic in the course with the same name.NOT_FOUND if the requested course or topic does not exist
HTTP request
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/topics/{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 topic.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Mask that identifies which fields on the topic 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 Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an INVALID_ARGUMENT error is returned. The following fields may be specified:
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 Topic.
Response body
If successful, the response body contains an instance of Topic.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.topics
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.topics.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- [Try it!](#try-it)\n\nUpdates one or more fields of a topic.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `FAILED_PRECONDITION` if there exists a topic in the course with the same name.\n- `NOT_FOUND` if the requested course or topic does not exist\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/topics/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n| `id` | `string` Identifier of the topic. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the topic 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 Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: - `name` 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 [Topic](/workspace/classroom/reference/rest/v1/courses.topics#Topic).\n\n### Response body\n\nIf successful, the response body contains an instance of [Topic](/workspace/classroom/reference/rest/v1/courses.topics#Topic).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.topics`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
