- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates one or more fields of a topic.
This method returns the following error codes:
-
PERMISSION_DENIEDif the requesting developer project did not create the corresponding topic or for access errors . -
INVALID_ARGUMENTif the request is malformed. -
FAILED_PRECONDITIONif there exists a topic in the course with the same name. -
NOT_FOUNDif 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
|
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an |
id
|
Identifier of the topic. |
Query 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:
-
name
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 .
