Method: users.messages.batchModify

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

Parámetros
userId

string

La dirección de correo electrónico del usuario. Se puede usar el valor especial me 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

Son 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 que se agregarán a los mensajes.

removeLabelIds[]

string

Es una lista de IDs de etiquetas que se quitarán 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 OAuth 2.0 Overview.