Method: users.messages.batchModify

Modifies the labels on the specified messages.

HTTP request

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

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.

Request body

The request body contains data with the following structure:

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

string

The IDs of the messages to modify. There is a limit of 1000 ids per request.
addLabelIds[]

string

A list of label IDs to add to messages.
removeLabelIds[]

string

A list of label IDs to remove from messages.

Response body

If successful, the response body is empty.

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 Authorization guide.