Overview
Domains
Mailboxes
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id}/filters \
--header 'Authorization: Bearer <token>'{
"ok": true,
"data": {
"mode": "off",
"rules": [
{
"type": "allow",
"pattern": "partner.com"
}
]
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Get mailbox sender filters
Returns the current sender-filter mode and rule set for a mailbox. Mailbox-scoped rules override any domain-wide rules set on the parent domain.
Responses carry a weak ETag — send it as If-None-Match to skip the body when the filter set has not changed (returns 304 Not Modified). The same ETag is the value to use in If-Match on the corresponding PUT for optimistic concurrency.
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id}/filters \
--header 'Authorization: Bearer <token>'{
"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
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Headers
Weak ETag from a previous response. Returns 304 when unchanged.
Path Parameters
Mailbox public ID
Response
Filter state
true Hide child attributes
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?