v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
Filters

Create a filter rule

Creates a new whitelist or blocklist filter. Per-domain filters require a Pro plan. Patterns are stored as lowercase.

post/filters

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

type'whitelist' | 'blocklist' required
patternstring required

Email address or pattern to filter

domain_idstring uuid nullable

Restrict filter to a specific domain (Pro plan required)

Response

Filter created

successtrue required