Method: users.messages.batchModify
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ändert die Labels der angegebenen Nachrichten.
HTTP-Anfrage
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
userId |
string
Die E-Mail-Adresse des Nutzers. Der spezielle Wert me kann verwendet werden, um den authentifizierten Nutzer anzugeben.
|
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
{
"ids": [
string
],
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
Felder |
ids[] |
string
Die IDs der Nachrichten, die geändert werden sollen. Pro Anfrage sind maximal 1.000 IDs zulässig.
|
addLabelIds[] |
string
Eine Liste mit Label-IDs, die Nachrichten hinzugefügt werden sollen.
|
removeLabelIds[] |
string
Eine Liste der Label-IDs, die aus Nachrichten entfernt werden sollen.
|
Antworttext
Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: users.messages.batchModify\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies the labels on the specified messages.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------|\n| ``` { \"ids\": [ string ], \"addLabelIds\": [ string ], \"removeLabelIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------|\n| `ids[]` | `string` The IDs of the messages to modify. There is a limit of 1000 ids per request. |\n| `addLabelIds[]` | `string` A list of label IDs to add to messages. |\n| `removeLabelIds[]` | `string` A list of label IDs to remove from messages. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]