younifyd
Menu

Gmail.users.threads.modify

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

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

Use it in a workflow

  1. Add a step and choose the Gmail connector.
  2. Pick the Gmail.users.threads.modify action (under users).
  3. Fill in the fields below, then reference the result from later steps as {{gmailUsersThreadsModify.response.data}}.

Request

Path parameters

userIdstringrequired

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

idstringrequired

The ID of the thread to modify.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Request body

Enter the body as JSON in the step's Body field.

addLabelIdsarray<string>

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

removeLabelIdsarray<string>

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

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

Response

Returns 200 with an object. Read it in later steps with {{gmailUsersThreadsModify.response.data.<field>}}.

historyIdstring (uint64)

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

idstring

The unique ID of the thread.

messagesarray<object>

The list of messages in the thread.

historyIdstring (uint64)

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

idstring

The immutable ID of the message.

internalDatestring (int64)

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.

labelIdsarray<string>

List of IDs of labels applied to this message.

payloadobject6 fields

A single MIME message part.

rawstring (byte)

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.

sizeEstimateinteger (int32)

Estimated size in bytes of the message.

snippetstring

A short part of the message text.

threadIdstring

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](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

snippetstring

A short part of the message text.

json
{
  "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"
}

Need more? See the Gmail guide for connection setup and behaviour shared by every action.