Method: users.messages.batchModify

Modifica las etiquetas y los valores de Classification Label en los mensajes especificados. En el caso de los administradores que modifican mensajes para los usuarios de su organización, las solicitudes requieren autorización con una cuenta de servicio que tenga autoridad de delegación en todo el dominio para suplantar a los usuarios con el permiso https://www.googleapis.com/auth/gmail.modify.restricted.

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
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    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

Una lista de IDs de etiquetas para agregar a los mensajes.
removeLabelIds[]

string

Una lista de IDs de etiquetas para quitar de los mensajes.
addClassificationLabels[]

object (ClassificationLabelValue)

Una lista de valores de Classification Label para agregar. Si ya se aplicó una Classification Label con el mismo ID de etiqueta al mensaje, se actualizarán los campos con IDs de campo existentes y se agregarán los campos con IDs de campo nuevos. Hay un límite de 20 valores de Classification Label por solicitud. Si el mensaje ya está clasificado y la cantidad total final de valores de Classification Label supera la cantidad máxima permitida de valores de Classification Label por mensaje, la modificación falla.
removeClassificationLabelIds[]

string

Una lista de valores de Classification Label para 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
  • https://www.googleapis.com/auth/gmail.modify.restricted

Para obtener más información, consulta la guía de autorización.