Skip to Content

The Vacation type of the TypeScript SDK, which vacation.get and vacation.set take or answer.

type Vacation = {
  fromDate: string | null
  htmlBody: string | null
  isEnabled: boolean
  state: string
  subject: string | null
  textBody: string | null
  toDate: string | null
}

Fields

FieldTypeDescription
fromDatestring | nullStart timestamp in ISO 8601 UTC format (e.g. 2026-08-01T09:00:00Z), or null
htmlBodystring | nullHTML auto-reply message content, or null
isEnabledbooleanTrue if out-of-office auto-reply is enabled
statestringOpaque state token for conditional updates (ETag / If-Match)
subjectstring | nullCustom auto-reply subject line, or null for default
textBodystring | nullPlain-text auto-reply message content
toDatestring | nullEnd timestamp in ISO 8601 UTC format (e.g. 2026-08-15T18:00:00Z), or null

Used by

MethodWhat it does
vacation.getGet out-of-office auto-reply settings
vacation.setUpdate out-of-office auto-reply settings

On this page