Method: users.messages.modify

यह, बताई गई ईमेल के लेबल और क्लासिफ़िकेशन लेबल की वैल्यू में बदलाव करता है. अपने संगठन के उपयोगकर्ताओं के लिए ईमेल में बदलाव करने वाले एडमिन के अनुरोधों के लिए, ऐसे सेवा खाते से अनुमति की ज़रूरत होती है जिसके पास, डोमेन-वाइड डेलिगेशन अथॉरिटी हो. इससे वह उपयोगकर्ताओं के तौर पर काम कर सकता है. इसके लिए, https://www.googleapis.com/auth/gmail.modify.restricted स्कोप का इस्तेमाल किया जाता है.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
userId

string

उपयोगकर्ता का ईमेल पता. ऑथेंटिकेट किए गए उपयोगकर्ता की पहचान करने के लिए, खास वैल्यू me का इस्तेमाल किया जा सकता है.
id

string

जिस ईमेल में बदलाव करना है उसका आईडी.

अनुरोध का मुख्य हिस्सा

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
फ़ील्ड
addLabelIds[]

string

इस ईमेल में जोड़े जाने वाले लेबल के आईडी की सूची. हर अपडेट के साथ, ज़्यादा से ज़्यादा 100 लेबल जोड़े जा सकते हैं.
removeLabelIds[]

string

इस ईमेल से हटाए जाने वाले लेबल के आईडी की सूची. हर अपडेट के साथ, ज़्यादा से ज़्यादा 100 लेबल हटाए जा सकते हैं.
addClassificationLabels[]

object (ClassificationLabelValue)

जोड़े जाने वाले क्लासिफ़िकेशन लेबल की वैल्यू की सूची. अगर ईमेल पर, एक ही लेबल आईडी वाला क्लासिफ़िकेशन लेबल पहले से लागू है, तो मौजूदा फ़ील्ड आईडी वाले फ़ील्ड अपडेट हो जाएंगे. साथ ही, नए फ़ील्ड आईडी वाले फ़ील्ड जुड़ जाएंगे. हर अनुरोध के लिए, ज़्यादा से ज़्यादा 20 क्लासिफ़िकेशन लेबल की वैल्यू जोड़ी जा सकती हैं. अगर ईमेल को पहले से ही क्लासिफ़ाई किया गया है और क्लासिफ़िकेशन लेबल की वैल्यू की कुल संख्या, हर ईमेल के लिए क्लासिफ़िकेशन लेबल की वैल्यू की तय सीमा से ज़्यादा है, तो बदलाव नहीं किया जा सकेगा.
removeClassificationLabelIds[]

string

इस ईमेल से हटाए जाने वाले क्लासिफ़िकेशन लेबल की वैल्यू की सूची.

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में Message का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.