Skip to main content
PUT
Replace mailbox sender filters

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match
string

Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.

Path Parameters

public_id
string
required

Mailbox public ID

Body

application/json
mode
enum<string>
required
Available options:
off,
allowlist,
denylist
rules
object[]
required

Replacement rule set. Maximum 1000 rules per request. An empty array is valid (no rules).

Maximum array length: 1000

Response

Updated filter state

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required