/gmail/v1/users/{userId}/watch

POST

Set up or update a push notification watch on the given user mailbox.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//watch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labelFilterAction": "include",
    "labelIds": [
        "string"
    ],
    "topicName": "string"
}'

Response Example

{
    "expiration": "string",
    "historyId": "string"
}

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

Body Params application/json

Set up or update a new push notification watch on this user's mailbox.

labelFilterAction

enum<string>

optional

Filtering behavior of labelIds list specified.

Allowed values:

includeexclude

labelIds

array[string]

optional

List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.

topicName

string

optional

A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request).

Examples

Responses

🟢200Successful response

application/json

Body

Push notification watch response.

expiration

string <int64>

optional

When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch.

historyId

string <uint64>

optional

The ID of the mailbox's current history record.

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/threads/{id}/untrash