Method: users.messages.batchModify

Modifica os marcadores e os valores do marcador de classificação nas mensagens especificadas. Para administradores que modificam mensagens de 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/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
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    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 marcadores a serem adicionados às mensagens.
removeLabelIds[]

string

Uma lista de IDs de marcadores a serem removidos das mensagens.
addClassificationLabels[]

object (ClassificationLabelValue)

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

string

Uma lista de valores de marcadores de classificação 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
  • https://www.googleapis.com/auth/gmail.modify.restricted

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