Method: users.threads.modify
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
שינוי התוויות שהוחלו על השרשור. ההגדרה הזו חלה על כל ההודעות בשרשור.
בקשת HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/modify
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
userId |
string
זוהי כתובת האימייל של המשתמש. אפשר להשתמש בערך המיוחד me כדי לציין את המשתמש המאומת.
|
id |
string
המזהה של השרשור שרוצים לשנות.
|
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
{
"addLabelIds": [
string
],
"removeLabelIds": [
string
]
} |
שדות |
addLabelIds[] |
string
רשימה של מזהי תוויות להוספה לשרשור הזה. אפשר להוסיף עד 100 תוויות בכל עדכון.
|
removeLabelIds[] |
string
רשימה של מזהי תוויות שרוצים להסיר מהשרשור הזה. בכל עדכון אפשר להסיר עד 100 תוויות.
|
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של Thread
.
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],[],null,["# Method: users.threads.modify\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nModifies the labels applied to the thread. This applies to all messages in the thread.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}/modify`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n| `id` | `string` The ID of the thread to modify. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------|\n| ``` { \"addLabelIds\": [ string ], \"removeLabelIds\": [ string ] } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------|\n| `addLabelIds[]` | `string` A list of IDs of labels to add to this thread. You can add up to 100 labels with each update. |\n| `removeLabelIds[]` | `string` A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Thread](/workspace/gmail/api/reference/rest/v1/users.threads#Thread).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]