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"
}
}Atomically replaces the sender-filter mode and rule set for an entire domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request.
For optimistic concurrency, send If-Match: <etag> using the ETag from a prior GET. A mismatched If-Match returns 409 conflict (the server’s ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
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.
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.
Domain public ID
off, allowlist, denylist Replacement rule set. Maximum 1000 rules per request. An empty array is valid (no rules).
1000Updated filter state
true Hide child attributes
Active filtering mode. off disables filtering (all senders accepted). allowlist only accepts senders matching a rule. denylist blocks senders matching a rule.
off, allowlist, denylist Was this page helpful?