Google: Creates a custom "from" send-as alias If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to `pending`; otherwise, the resource will be created with verification status set to `accepted` 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) This method is only available to service account clients that have been delegated domain-wide authority

Google gmailUsersSettingsSendAs.gmailUsersSettingsSendAsCreate: arguments, response, policy and SDK examples.

← Gmail users settings send as operations · Get started

Operation google.gmail_users_settings_sendas_create

Provider route: POST /gmail/v1/users/{userId}/settings/sendAs. 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"]["gmailUsersSettingsSendAsCreate"]>[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.gmailUsersSettingsSendAsCreate(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_create(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	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

Schemas

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. The send-as alias must be a valid email address.
`displayName`	string	Optional	A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
`isDefault`	boolean	Optional	Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
`isPrimary`	boolean	Optional	Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
`replyToAddress`	string	Optional	An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
`sendAsEmail`	string	Optional	The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
`signature`	string	Optional	An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
`smtpMsa`	Model	Optional	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 — smtp Msa An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
`treatAsAlias`	boolean	Optional	Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
`verificationStatus`	string	Optional	Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. Known values: verificationStatusUnspecified, accepted, pending

Field	Type	Presence	Description and constraints
`$`	object	Root	Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. The send-as alias must be a valid email address.
`displayName`	string	Optional	A name that appears in the "From:" header for mail sent using this alias. For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
`isDefault`	boolean	Optional	Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is `true`. Changing this from `false` to `true` for an address will result in this field becoming `false` for the other previous default address.
`isPrimary`	boolean	Optional	Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
`replyToAddress`	string	Optional	An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header.
`sendAsEmail`	string	Optional	The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.
`signature`	string	Optional	An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
`smtpMsa`	Model	Optional	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 smtp Msa An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases.
`treatAsAlias`	boolean	Optional	Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.
`verificationStatus`	string	Optional	Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. One of: verificationStatusUnspecified, accepted, pending

Field	Type	Presence	Description and constraints
`$`	object	Root	Configuration for communication with an SMTP service.
`host`	string	Optional	The hostname of the SMTP service. Required.
`password`	string	Optional	The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
`port`	JSON	Optional
`port (anyOf 1)`	integer	Alternative	The port of the SMTP service. Required. Format: int32
`port (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`securityMode`	string	Optional	The protocol that will be used to secure communication with the SMTP service. Required. Known values: securityModeUnspecified, none, ssl, starttls
`username`	string	Optional	The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.

Field	Type	Presence	Description and constraints
`$`	object	Root	Configuration for communication with an SMTP service.
`host`	string	Optional	The hostname of the SMTP service. Required.
`password`	string	Optional	The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
`port`	integer	Optional	The port of the SMTP service. Required. Format: int32
`securityMode`	string	Optional	The protocol that will be used to secure communication with the SMTP service. Required. One of: securityModeUnspecified, none, ssl, starttls
`username`	string	Optional	The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_sendas_create. Catalog operation: gmail.users.settings.sendAs.create. 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.sharing"]

Official provider source

Report an issue with this page