Skip to main content
POST

Authorizations

Authorization
string
header
required

API key for account management endpoints. Use your api_ prefixed token.

Body

application/json
name
string
required

Rule name (alphanumeric, spaces, hyphens, underscores, periods)

Required string length: 1 - 100
Example:

"Allow partner emails"

description
string

Optional rule description

Maximum string length: 500
Example:

"Allow all emails from partner domain across all our domains"

senders
object[]
recipients
object[]
subjects
object[]
body
object[]
headers
object[]
ips
object[]
size
object | null
attachments
object[]

Response

Rule created successfully

success
boolean
Example:

true

uuid
string<uuid>

UUID of the created rule

Example:

"550e8400-e29b-41d4-a716-446655440000"