Method: users.messages.modify

برچسب های روی پیام مشخص شده را تغییر می دهد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
userId

string

آدرس ایمیل کاربر. مقدار ویژه me می تواند برای نشان دادن کاربر تأیید شده استفاده شود.

id

string

شناسه پیام برای تغییر.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
فیلدها
addLabelIds[]

string

فهرستی از شناسه‌های برچسب‌هایی که باید به این پیام اضافه شوند. با هر به روز رسانی می توانید تا 100 برچسب اضافه کنید.

removeLabelIds[]

string

فهرست شناسه‌های برچسب‌هایی که باید از این پیام حذف شوند. با هر به روز رسانی می توانید تا 100 برچسب را حذف کنید.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Message است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.