Skip to content

Google: Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body

Gets vacation responder settings. For more information, see [Manage vacation settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/vacation_settings).: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body

FieldTypePresenceDescription and constraints
$objectRootVacation auto-reply settings for an account. These settings correspond to the “Vacation responder” feature in the web interface.
enableAutoReplybooleanOptionalFlag that controls whether Gmail automatically replies to messages.
endTimestringOptionalAn optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.
Format: int64
responseBodyHtmlstringOptionalResponse body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
responseBodyPlainTextstringOptionalResponse body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
responseSubjectstringOptionalOptional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
restrictToContactsbooleanOptionalFlag that determines whether responses are sent to recipients who are not in the user’s list of contacts.
restrictToDomainbooleanOptionalFlag that determines whether responses are sent to recipients who are outside of the user’s domain. This feature is only available for Google Workspace users.
startTimestringOptionalAn optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`.
Format: int64

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.