Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for creating an email allow/block rule

direction
enum<string>
required

SEND governs who this org's agents may email (enforced when a send is attempted); RECEIVE governs whose mail is accepted for them (enforced at ingest, before the message is stored or any webhook fires). Reply-scope is not implemented.

Available options:
SEND,
RECEIVE
action
enum<string>
required

BLOCK refuses the matching address. ALLOW does two things: it carves an exception out of a broader BLOCK, AND it switches that scope+direction into allow-list mode — once any ALLOW rule exists, addresses it does not cover are refused. Adding one ALLOW rule therefore restricts far more than it permits.

Available options:
ALLOW,
BLOCK
patternType
enum<string>
required

ADDRESS matches one exact address. DOMAIN matches the domain and its subdomains ('example.com' covers 'a@mail.example.com' but never 'a@notexample.com'). ADDRESS beats DOMAIN when both match.

Available options:
ADDRESS,
DOMAIN
pattern
string
required

The address or domain this rule matches. Normalized to lowercase. Validated against patternType.

Required string length: 1 - 320
agentId
string | null

Scope the rule to one agent. Omit or null for an org-wide rule. An agent's own rules take precedence over org-wide rules — including its allow-list, which does NOT inherit the org's.

Pattern: ^[cC][^\s-]{8,}$
note
string | null

Optional operator note ('known phisher', 'competitor'). Surfaced in the error a blocked send returns and in the security event, so a refusal is diagnosable without opening the console.

Maximum string length: 500

Response

200 - application/json

OK

An email allow/block rule

id
string
required

Unique identifier of the rule

Pattern: ^[cC][^\s-]{8,}$
direction
enum<string>
required

SEND governs who this org's agents may email (enforced when a send is attempted); RECEIVE governs whose mail is accepted for them (enforced at ingest, before the message is stored or any webhook fires). Reply-scope is not implemented.

Available options:
SEND,
RECEIVE
action
enum<string>
required

BLOCK refuses the matching address. ALLOW does two things: it carves an exception out of a broader BLOCK, AND it switches that scope+direction into allow-list mode — once any ALLOW rule exists, addresses it does not cover are refused. Adding one ALLOW rule therefore restricts far more than it permits.

Available options:
ALLOW,
BLOCK
patternType
enum<string>
required

ADDRESS matches one exact address. DOMAIN matches the domain and its subdomains ('example.com' covers 'a@mail.example.com' but never 'a@notexample.com'). ADDRESS beats DOMAIN when both match.

Available options:
ADDRESS,
DOMAIN
pattern
string
required

The normalized (lowercase) address or domain this rule matches

agentId
string | null
required

The agent this rule is scoped to, or null for an org-wide rule

Pattern: ^[cC][^\s-]{8,}$
note
string | null
required

Operator note, or null if not set

createdAt
string<date-time>
required

Timestamp when the rule was created

updatedAt
string<date-time>
required

Timestamp when the rule was last modified