Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-137956179.1 KB
users

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. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.

put/gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}

Path parameters

userIdstring required

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

sendAsEmailstring required

The send-as alias to be updated.

Request body

replyToAddressstring

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.

verificationStatus'verificationStatusUnspecified' | 'accepted' | 'pending'

Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases.

displayNamestring

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.

signaturestring

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.

isPrimaryboolean

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.

treatAsAliasboolean

Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases.

sendAsEmailstring

The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create.

isDefaultboolean

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.

Response

Successful response