Gmail API

/gmail/v1/users/{userId}/messages/{id}/modify

POST/gmail/v1/users/{userId}/messages/{id}/modify

Modifies the labels on the specified message.

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

string

required

The ID of the message to modify.

addLabelIds

array[string]

optional

A list of IDs of labels to add to this message. You can add up to 100 labels with each update.

removeLabelIds

array[string]

optional

A list IDs of labels to remove from this message. You can remove up to 100 labels with each update.

{
  "addLabelIds": [
    "string"
  ],
  "removeLabelIds": [
    "string"
  ]
}

Request samples

Responses

Successful response(200)

Successful response

HTTP Code: 200

Content Type : JSONapplication/json

An email message.

historyId

string <uint64>

optional

The ID of the last history record that modified this message.

string

optional

The immutable ID of the message.

internalDate

string <int64>

optional

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header.

labelIds

array[string]

optional

List of IDs of labels applied to this message.

payload

object (MessagePart)

optional

The parsed email structure in the message parts.

body

object (MessagePartBody)

optional

The message part body for this part, which may be empty for container MIME message parts.

filename

string

optional

The filename of the attachment. Only present if this message part represents an attachment.

headers

array[object (MessagePartHeader) {2}]

optional

List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject.

mimeType

string

optional

The MIME type of the message part.

partId

string

optional

The immutable ID of the message part.

parts

array[object (MessagePart) {6}]

optional

The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521.

raw

string <byte>

optional

The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied.

sizeEstimate

integer <int32>

optional

Estimated size in bytes of the message.

snippet

string

optional

A short part of the message text.

threadId

string

optional

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested threadId must be specified on the Message or Draft.Message you supply with your request. 2. The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. 3. The Subject headers must match.

{
  "historyId": "string",
  "id": "string",
  "internalDate": "string",
  "labelIds": [
    "string"
  ],
  "payload": {
    "body": {
      "attachmentId": "string",
      "data": "string",
      "size": 0
    },
    "filename": "string",
    "headers": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "mimeType": "string",
    "partId": "string",
    "parts": [
      {}
    ]
  },
  "raw": "string",
  "sizeEstimate": 0,
  "snippet": "string",
  "threadId": "string"
}

Last modified: a year ago