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

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 governed: "send" (your inboxes mailing out), "receive" (mail coming in) or "reply".

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

Whether the entry allowed or blocked.

Available options:
allow,
block
entry
string
required

The email address or domain whose entry to remove.

Maximum string length: 320
inbox
string

Remove from one inbox's own list instead of the workspace-wide one.

Required string length: 1 - 320

Response

The result

removed
boolean
required

Whether the entry was removed.