gmail.users.settings.sendAs.update
Update a Gmail send-as alias's display name, signature, reply-to address, or default status so messages sent from that address show the correct identity.
Instructions
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 [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON SendAs object accepting displayName, isDefault, isPrimary, replyToAddress, sendAsEmail, signature, smtpMsa, treatAsAlias and 1 more fields; pass it via params or whole via body_file Siblings over the same resource: create, delete, get, list, patch, verify.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] User's email address. The special value "me" can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON SendAs object. | |
| sendAsEmail | Yes | [URL path segment] The send-as alias to be updated. | |
| request_body | No | Request body of type SendAs: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| smtpMsa | No | ||
| isDefault | No | ||
| isPrimary | No | ||
| signature | No | ||
| displayName | No | ||
| sendAsEmail | No | ||
| treatAsAlias | No | ||
| replyToAddress | No | ||
| verificationStatus | No |