Method: users.messages.batchModify

Modifica os rótulos das mensagens especificadas.

Solicitação HTTP

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

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.

Corpo da solicitação

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

Representação JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
Campos
ids[]

string

Os IDs das mensagens a serem modificadas. Há um limite de 1.000 IDs por solicitação.
addLabelIds[]

string

Uma lista de IDs de rótulos para adicionar às mensagens.
removeLabelIds[]

string

Uma lista de IDs de rótulos a serem removidos das mensagens.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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