Method: users.messages.batchModify
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Modifica las etiquetas de los mensajes especificados.
Solicitud HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
userId |
string
La dirección de correo electrónico del usuario. El valor especial me se puede usar para indicar el usuario autenticado.
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
| Representación JSON |
{
"ids": [
string
],
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
| Campos |
ids[] |
string
Los IDs de los mensajes que se modificarán Hay un límite de 1,000 IDs por solicitud.
|
addLabelIds[] |
string
Es una lista de IDs de etiquetas para agregar a los mensajes.
|
removeLabelIds[] |
string
Es una lista de IDs de etiquetas que se deben quitar de los mensajes.
|
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
