Method: users.labels.update
Updates the specified label.
HTTP request
PUT https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
The user's email address. The special value me can be used to indicate the authenticated user.
|
id |
string
The ID of the label to update.
|
Request body
The request body contains an instance of Label.
Response body
If successful, the response body contains an instance of Label.
Authorization scopes
Requires one of the following OAuth scopes:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.labels
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Updates the specified label using a PUT request to the Gmail API."],["Requires providing the user's email address and the label ID as path parameters."],["The request and response bodies utilize the `Label` object to handle label data."],["Authorization is necessary using one of the specified OAuth scopes related to Gmail access and modification."]]],["This document outlines the process to update a label using a `PUT` HTTP request to the Gmail API. The request targets a specific label via `userId` and `id` path parameters. The `userId` can be the email or 'me' for the authenticated user. The request body uses a `Label` instance, and a successful response returns another `Label` instance. Authorization requires one of three specified OAuth scopes. You can use the specified URL and try it with the provided parameters and body.\n"]]
