跳到主要内容

Update a filter

PUT /api/2.0/mail/filters

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

Request body​

filter​

type: object

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

Request example​

{}

Returns​

Updated filter. A request that is not authenticated returns 401.

Id​

type: integer

Example: 1

Name​

type: string

Example: "name"

Position​

type: integer

Example: 2

Enabled​

type: boolean

Example: true

Conditions​

type: MailSieveFilterConditionData[]

Actions​

type: MailSieveFilterActionData[]

Options​

type: MailSieveFilterOptionsData

Response example​

{
  "Id": 1,
  "Name": "name",
  "Position": 2,
  "Enabled": true,
  "Conditions": [
    {
      "Key": 1,
      "Operation": 1,
      "Value": "value"
    }
  ],
  "Actions": [
    {
      "Action": 1,
      "Data": "data"
    }
  ],
  "Options": {
    "MatchMultiConditions": 1,
    "ApplyTo": {
      "Folders": [
        1
      ],
      "Mailboxes": [
        1
      ],
      "WithAttachments": 1
    },
    "IgnoreOther": true
  }
}