Skip to main content
PUT
/
domains
/
{public_id}
/
filters
Replace domain-wide sender filters
curl --request PUT \
  --url https://app.sendmux.ai/api/v1/domains/{public_id}/filters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "off",
  "rules": [
    {
      "type": "allow",
      "pattern": "partner.com"
    }
  ]
}
'
{
  "ok": true,
  "data": {
    "mode": "off",
    "rules": [
      {
        "type": "allow",
        "pattern": "partner.com"
      }
    ]
  },
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...

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

Domain 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

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