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.
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."],[[["This endpoint allows modification of labels on multiple messages in batches, by adding or removing label IDs."],["Users need to provide message IDs and desired label IDs for adding or removing."],["It uses an HTTP POST request with specific path parameters and a JSON request body structure."],["Successful execution results in an empty response body, indicating the labels were modified."],["Authorization is required, using specified OAuth scopes related to Gmail access and modification."]]],["This describes how to modify labels on Gmail messages via an HTTP POST request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify`. The `userId` path parameter specifies the user. The request body, in JSON format, includes `ids` (message IDs), `addLabelIds`, and `removeLabelIds` to specify which labels to modify. A maximum of 1000 message IDs is allowed per request. A successful request returns an empty response body and requires specific OAuth scopes.\n"]]
