Update a filter

PUT /api/2.0/mail/filters

Request

Updates the selected filter with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

filterunknown

New filter parameters: ID, name, position, enabled, conditions, actions, options

Examples

PUT /api/2.0/mail/filters HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url https://example.com/api/2.0/mail/filters \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated filter

Idintegerformat: int32

Namestring

Positionintegerformat: int32

Enabledboolean

Conditionsarray of object

Keyenum of integerformat: int32

[0 - From, 1 - ToOrCc, 2 - To, 3 - Cc, 4 - Subject]

Can be one of: From, ToOrCc, To, Cc, Subject.

Operationenum of integerformat: int32

[0 - Matches, 1 - NotMatches, 2 - Contains, 3 - NotContains]

Can be one of: Matches, NotMatches, Contains, NotContains.

Valuestring

Actionsarray of object

Actionenum of integerformat: int32

[0 - DeleteForever, 1 - MoveTo, 2 - MarkTag, 3 - MarkAsImportant, 4 - MarkAsRead]

Can be one of: DeleteForever, MoveTo, MarkTag, MarkAsImportant, MarkAsRead.

Datastring

Optionsobject

MatchMultiConditionsenum of integerformat: int32

[0 - None, 1 - MatchAll, 2 - MatchAtLeastOne]

Can be one of: None, MatchAll, MatchAtLeastOne.

ApplyToobject

Foldersarray of integer

Mailboxesarray of integer

WithAttachmentsenum of integerformat: int32

[0 - WithAndWithoutAttachments, 1 - WithAttachments, 2 - WithoutAttachments]

Can be one of: WithAndWithoutAttachments, WithAttachments, WithoutAttachments.

IgnoreOtherboolean

401

Unauthorized