Skip to main content
POST
email.filter.entry.add

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
direction
enum<string>
required

Which traffic the entry governs: "send" (your inboxes mailing out), "receive" (mail coming in) or "reply".

Available options:
send,
receive,
reply
type
enum<string>
required

"allow" permits the traffic, "block" refuses it.

Available options:
allow,
block
entry
string
required

The email address or domain to allow or block, e.g. partner@example.com.

Required string length: 1 - 320
inbox
string

Scope the entry to one inbox instead of the whole workspace.

Required string length: 1 - 320
reason
string

Why you are adding it.

Required string length: 1 - 500

Response

The result

entry
string
required

The email address or domain the entry is about.

direction
enum<string>
required

Which traffic the entry governs.

Available options:
send,
receive,
reply
type
enum<string>
required

Whether the entry allows or blocks.

Available options:
allow,
block
entryType
enum<string>
required

"email" is one address; "domain" covers a whole domain.

Available options:
email,
domain
inbox
string

The one inbox the entry is scoped to, when it is not workspace-wide.

reason
string

Why the entry was added.

readOnly
boolean

Entries the service manages itself cannot be removed.

createdAt
string

When the entry was added, ISO 8601.