Method: users.messages.modify

Modifica os rótulos e os valores de rótulo de classificação na mensagem especificada. Para administradores que modificam mensagens para usuários na organização, as solicitações exigem autorização com uma conta de serviço que tenha autoridade de delegação em todo o domínio para representar usuários com o escopo https://www.googleapis.com/auth/gmail.modify.restricted.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userId

string

O endereço de e-mail do usuário. O valor especial me pode ser usado para indicar o usuário autenticado.
id

string

O ID da mensagem a ser modificada.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Campos
addLabelIds[]

string

Uma lista de IDs de marcadores a serem adicionados a esta mensagem. É possível adicionar até 100 rótulos a cada atualização.
removeLabelIds[]

string

Uma lista de IDs de marcadores a serem removidos desta mensagem. É possível remover até 100 rótulos com cada atualização.
addClassificationLabels[]

object (ClassificationLabelValue)

Uma lista de valores de rótulo de classificação a serem adicionados. Se um rótulo de classificação com o mesmo ID já estiver aplicado à mensagem, os campos com IDs atuais serão atualizados, e os campos com novos IDs serão adicionados. Há um limite de 20 valores de rótulo de classificação por solicitação. Se a mensagem já estiver classificada e o número total final de valores de rótulo de classificação exceder o máximo permitido por mensagem, a modificação vai falhar.
removeClassificationLabelIds[]

string

Uma lista de valores de rótulo de classificação a serem removidos desta mensagem.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Message.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

Para mais informações, consulte o guia de autorização.