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

POST

users

Modifies the labels applied to the thread. This applies to all messages in the thread.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//threads//modify' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "historyId": "string",
  "id": "string",
  "messages": [
    {
      "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"
    }
  ],
  "snippet": "string"
}

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 thread to modify.

Body Params application/json

addLabelIds

array[string]

optional

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

removeLabelIds

array[string]

optional

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

Examples

Responses

🟢200Successful response

application/json

Body

A collection of messages representing a conversation.

historyId

string <uint64>

optional

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

string

optional

The unique ID of the thread.

messages

array[object (Message) {9}]

optional

The list of messages in the thread.

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.

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.

snippet

string

optional

A short part of the message text.

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/threads/{id}

/gmail/v1/users/{userId}/threads/{id}/trash