Skip to main content
PUT
Set correspondent policy mode

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

podId
string

Confine the operation to one pod's policy. Accepts the pod ID. Mutually exclusive with inboxId.

inboxId
string

Confine the operation to one inbox's policy. Mutually exclusive with podId.

Body

application/json
mode
enum<string>
required

none = no filtering; allowlist = only listed correspondents are permitted (empty allowlist denies all — fail closed); inherit = defer to the parent scope (pod, then account). Not valid at the account scope.

Available options:
none,
allowlist,
inherit
direction
enum<string>

inbound governs who may send to the inbox; outbound governs who the inbox may send to (enforced across To, Cc, and Reply-To on every send path).

Available options:
inbound,
outbound

Response

The updated mode

The updated mode