Google: Updates a send-as alias If a signature is provided, Gmail will sanitize the HTML before saving it with the alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority

← gmail_users_settings_send_as operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation google.gmail_users_settings_sendas_update

Provider route: PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}. 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["gmailUsersSettingsSendAs"]["gmailUsersSettingsSendAsUpdate"]>[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.gmailUsersSettingsSendAs.gmailUsersSettingsSendAsUpdate(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_settings_send_as.gmail_users_settings_send_as_update(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.sendAsEmail	string	Required within parent	The send-as alias to be updated.
path.userId	string	Required within parent	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 Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — request body — body

Referenced models: Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — 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
$	Model	Root	Expand Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Referenced models: Patch the specified send-as alias For more information, see Manage aliases and signatures with the Gmail API (https: developers google com workspace gmail api guides alias and signature settings) — response body

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_sendas_update. Catalog operation: gmail.users.settings.sendAs.update. 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://www.googleapis.com/auth/gmail.settings.basic", "https://www.googleapis.com/auth/gmail.settings.sharing"]

Official provider source