Google: Modifies the labels and the Classification Label values on the specified messages For administrators modifying messages for users in their organization, requests require authorization with a service account (https: developers google com identity protocols O Auth2 Service Account) that has domain-wide delegation authority (https: developers google com identity protocols O Auth2 Service Account#delegatingauthority) to impersonate users with the `https: www googleapis com auth gmail modify restricted` scope

← Gmail users messages operations · Get started

Operation google.gmail_users_messages_batchmodify

Provider route: POST /gmail/v1/users/{userId}/messages/batchModify. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["gmailUsersMessages"]["gmailUsersMessagesBatchModify"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.gmailUsersMessages.gmailUsersMessagesBatchModify(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.gmail_users_messages.gmail_users_messages_batch_modify(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.userId	string	Required within parent	The user’s email address. The special value `me` can be used to indicate the authenticated user. Default: me
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	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.
body	Model	Required within parent	Expand Modifies the labels and the Classification Label values on the specified messages For administrators modifying messages for users in their organization, requests require authorization with a service account (https: developers google com identity protocols O Auth2 Service Account) that has domain-wide delegation authority (https: developers google com identity protocols O Auth2 Service Account#delegatingauthority) to impersonate users with the `https: www googleapis com auth gmail modify restricted` scope — request body — body

Referenced models: Modifies the labels and the Classification Label values on the specified messages For administrators modifying messages for users in their organization, requests require authorization with a service account (https: developers google com identity protocols O Auth2 Service Account) that has domain-wide delegation authority (https: developers google com identity protocols O Auth2 Service Account#delegatingauthority) to impersonate users with the `https: www googleapis com auth gmail modify restricted` scope — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	null	Root

Schemas

Modifies the labels and the Classification Label values on the specified messages For administrators modifying messages for users in their organization, requests require authorization with a service account (https: developers google com identity protocols O Auth2 Service Account) that has domain-wide delegation authority (https: developers google com identity protocols O Auth2 Service Account#delegatingauthority) to impersonate users with the `https: www googleapis com auth gmail modify restricted` scope — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
addClassificationLabels	array	Optional	A list of Classification Label values to add. If a Classification Label with the same label ID is already applied to the message, fields with existing field IDs will be updated and fields with new field IDs will be added. There's a limit of 20 Classification Label values per request. If the message is already classified and the final total number of Classification Label values exceeds the maximum allowed number of Classification Label values per message, the modification fails.
addClassificationLabels[]	Model	Each item	Expand Gets the specified message — response body — classification Label Values item
addLabelIds	array	Optional	A list of label IDs to add to messages.
addLabelIds[]	string	Each item
ids	array	Optional	The IDs of the messages to modify. There is a limit of 1000 ids per request.
ids[]	string	Each item
removeClassificationLabelIds	array	Optional	A list of Classification Label values to remove from messages.
removeClassificationLabelIds[]	string	Each item
removeLabelIds	array	Optional	A list of label IDs to remove from messages.
removeLabelIds[]	string	Each item

Referenced models: Gets the specified message — response body — classification Label Values item

Gets the specified message — response body — classification Label Values item

Field	Type	Presence	Description and constraints
$	object	Root	Classification Labels applied to the email message. Classification Labels are different from Gmail inbox labels. Only used for Google Workspace accounts. [Learn more about classification labels](https://support.google.com/a/answer/9292382).
fields	array	Optional	Field values for the given classification label ID.
fields[]	Model	Each item	Expand Gets the specified message — response body — classification Label Values item fields item
labelId	string	Optional	Required. The canonical or raw alphanumeric classification label ID. Maps to the ID field of the Google Drive Label resource.

Referenced models: Gets the specified message — response body — classification Label Values item fields item

Gets the specified message — response body — classification Label Values item fields item

Field	Type	Presence	Description and constraints
$	object	Root	Field values for a classification label.
fieldId	string	Optional	Required. The field ID for the Classification Label Value. Maps to the ID field of the Google Drive `Label.Field` object.
selection	string	Optional	Selection choice ID for the selection option. Should only be set if the field type is `SELECTION` in the Google Drive `Label.Field` object. Maps to the id field of the Google Drive `Label.Field.SelectionOptions` resource.

Policy, approvals and errors

SDK function policy ID: google.gmail_users_messages_batchmodify. Catalog operation: gmail.users.messages.batchModify. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify"]

No-content response statuses: [204]

Official provider source