Create an email filter

POST {{baseUrl}}/emails/mailboxes/:email/settings/filters

Creates a message filter.

Scopes: mail:write

Rate Limit Label: LIGHT

Not supported in Gov cluster

Request Body

{"action"=>{"addLabelIds"=>["<string>", "<string>"], "removeLabelIds"=>["<string>", "<string>"], "forward"=>"<string>"}, "criteria"=>{"from"=>"<string>", "to"=>"<string>", "subject"=>"<string>", "query"=>"<string>", "negatedQuery"=>"<string>", "hasAttachment"=>"<boolean>", "size"=>"<integer>", "sizeComparison"=>"smaller"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;criteria&quot;:{&quot;from&quot;:&quot;\u003cstring\u003e&quot;,&quot;to&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject&quot;:&quot;\u003cstring\u003e&quot;,&quot;query&quot;:&quot;\u003cstring\u003e&quot;,&quot;negatedQuery&quot;:&quot;\u003cstring\u003e&quot;,&quot;hasAttachment&quot;:&quot;\u003cboolean\u003e&quot;,&quot;size&quot;:&quot;\u003cinteger\u003e&quot;,&quot;sizeComparison&quot;:&quot;larger&quot;},&quot;action&quot;:{&quot;addLabelIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;removeLabelIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;forward&quot;:&quot;\u003cstring\u003e&quot;}}