Delete filter

Delete sieve (message) filter at specified position

  • HTTP Method: DELETE
  • URL: https://example.domain.tld/api/v1/sieve_filters/
  • Require authentication: Yes
  • Permission level required: MailUser

Request parameters

Parameter Type Description Required
filter_position int Filter position from 1 to 99 Required

Response parameters

Parameter Type Description
filter_position int Filter position from 1 to 99
status str Status

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/sieve_filters/"
data = {
"filter_position" : 1
}
r = requests.delete(url, json=data, auth=("u1@vonmail.com","long-auth_token-here"))
try:
    pprint(r.json())
except: 
    print(r.text)

Example response (JSON)

{'filter_position': 1, 'status': 'deleting'}