Method: users.messages.modify

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userId

string

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

id

string

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

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

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

string

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

removeLabelIds[]

string

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

بدنه پاسخ

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

دامنه‌های مجوز

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

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .