Method: users.settings.filters.create

Creates a filter. Note: you can only create a maximum of 1,000 filters.

HTTP request

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

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

Request body

The request body contains an instance of Filter.

Response body

If successful, the response body contains a newly created instance of Filter.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/gmail.settings.basic

For more information, see the Authorization guide.