gmail.users.settings.filters.create

POST /gmail/v1/users/{userId}/settings/filters

Copy endpoint

https://gmail.googleapis.com/

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

Parameters

path Path Parameters

Name	Type
`userId` required User's email address. The special value "me" can be used to indicate the authenticated user.	string

query Query Parameters

Name	Type
`fields` Selector specifying which fields to include in a partial response.	string
`upload_protocol` Upload protocol for media (e.g. "raw", "multipart").	string
`uploadType` Legacy upload protocol for media (e.g. "media", "multipart").	string
`$.xgafv` V1 error format.	"1" \| "2"
`oauth_token` OAuth 2.0 token for the current user.	string
`prettyPrint` Returns response with indentations and line breaks.	boolean
`quotaUser` Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.	string
`access_token` OAuth access token.	string
`callback` JSONP	string
`key` API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.	string
`alt` Data format for response.	"json" \| "media" \| "proto"

Request Body

application/json

interface Filter {
action?:

FilterAction

A set of actions to perform on a message.

interface FilterAction {
addLabelIds?: string[];
forward?: string;
removeLabelIds?: string[];
}

;
criteria?:

FilterCriteria

Message matching criteria.

interface FilterCriteria {
excludeChats?: boolean;
from?: string;
hasAttachment?: boolean;
negatedQuery?: string;
query?: string;
size?: number;
sizeComparison?: "unspecified" | "smaller" | "larger";
subject?: string;
to?: string;
}

;
id?: string;
}

Responses

200 */*

Successful response