Method: users.messages.modify

Modifica las etiquetas y los valores de las etiquetas de clasificación en el mensaje especificado. 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 alcance https://www.googleapis.com/auth/gmail.modify.restricted.

Solicitud HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify

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.
id

string

ID del mensaje que se modificará.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Campos
addLabelIds[]

string

Es una lista de IDs de etiquetas que se agregarán a este mensaje. Puedes agregar hasta 100 etiquetas con cada actualización.
removeLabelIds[]

string

Es una lista de IDs de etiquetas que se quitarán de este mensaje. Puedes quitar hasta 100 etiquetas con cada actualización.
addClassificationLabels[]

object (ClassificationLabelValue)

Es una lista de valores de etiquetas de clasificación que se agregarán. Si ya se aplicó una etiqueta de clasificación 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 la etiqueta de clasificación supera la cantidad máxima permitida de valores de la etiqueta de clasificación por mensaje, la modificación falla.
removeClassificationLabelIds[]

string

Es una lista de valores de etiquetas de clasificación que se quitarán de este mensaje.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Message.

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.