Method: users.messages.batchModify

שינוי התוויות בהודעות שצוינו.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
userId

string

כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ]
}
שדות
ids[]

string

מזהי ההודעות שיש לשנות. בכל בקשה אפשר לכלול עד 1,000 מזהים.
addLabelIds[]

string

רשימת מזהים של תוויות שאפשר להוסיף להודעות.
removeLabelIds[]

string

רשימת מזהים של תוויות להסרה מהודעות.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין במדריך להרשאות.