younifyd
Menu

Gmail.users.messages.batch Modify

Modifies the labels on the specified messages.

POST/gmail/v1/users/{userId}/messages/batchModify

Use it in a workflow

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

Request

Path parameters

userIdstringrequired

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

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 label IDs to add to messages.

idsarray<string>

The IDs of the messages to modify. There is a limit of 1000 ids per request.

removeLabelIdsarray<string>

A list of label IDs to remove from messages.

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

Response

Returns 200 with a any. Read it in later steps with {{gmailUsersMessagesBatchModify.response.data.<field>}}.

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