Method: users.messages.modify

Modifies the labels on the specified message.

HTTP request

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify

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 message to modify.

Request body

The request body contains data with the following structure:

JSON representation
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
Fields
addLabelIds[]

string

A list of IDs of labels to add to this message.

removeLabelIds[]

string

A list IDs of labels to remove from this message.

Response body

If successful, the response body contains an instance of Message.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify

For more information, see the OAuth 2.0 Overview.