Skip to content

Google: Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — response body

Set up or update a push notification watch on the given user mailbox. For more information, see [Configure push notifications in Gmail API](https://developers.google.com/workspace/gmail/api/guides/push).: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Set up or update a push notification watch on the given user mailbox For more information, see Configure push notifications in Gmail API (https: developers google com workspace gmail api guides push) — response body

FieldTypePresenceDescription and constraints
$objectRootPush notification watch response.
expirationstringOptionalWhen Gmail will stop sending notifications for mailbox updates (epoch millis). Call `watch` again before this time to renew the watch.
Format: int64
historyIdstringOptionalThe ID of the mailbox’s current history record.
Format: uint64

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.