gmail.users.settings.updateVacation
Configure or disable a Gmail vacation responder by updating auto-reply settings such as subject, message body, schedule, and contact/domain restrictions. Returns the updated VacationSettings as JSON.
Instructions
Updates vacation responder settings. For more information, see Manage vacation settings with the Gmail API [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON VacationSettings object accepting enableAutoReply, endTime, responseBodyHtml, responseBodyPlainText, responseSubject, restrictToContacts, restrictToDomain, startTime; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop.
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 VacationSettings object. | |
| request_body | No | Request body of type VacationSettings: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endTime | No | ||
| startTime | No | ||
| enableAutoReply | No | ||
| responseSubject | No | ||
| responseBodyHtml | No | ||
| restrictToDomain | No | ||
| restrictToContacts | No | ||
| responseBodyPlainText | No |