Method: users.messages.batchModify

Memodifikasi label pada pesan yang ditentukan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Alamat email pengguna. Nilai khusus me dapat digunakan untuk menunjukkan pengguna yang diautentikasi.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
Kolom
ids[]

string

ID pesan yang akan diubah. Ada batas 1.000 ID per permintaan.

addLabelIds[]

string

Daftar ID label untuk ditambahkan ke pesan.

removeLabelIds[]

string

Daftar ID label yang akan dihapus dari pesan.

Isi respons

Jika berhasil, isi respons akan kosong.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.