Method: users.labels.patch

Patch the specified label. For more information, see Manage labels.

HTTP request

PATCH 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 2026年04月15日 UTC.