Sign in
Agents

Set inbox mail policy

Set the sender allowlist and send/reply/read access rules for an inbox owned by the authenticated organization.

put/mail/v1/inboxes/{inboxId}/policy

Path parameters

inboxIdstring required

Request body

enforceSenderAllowlistboolean
allowedSenderPatternsstring[]

Exact emails, @domain rules, or *

readAccessRulesstring[]

Rules like organization, operator, user:<id>, api_key, api_key:<id>, clerk_session, or *

replyAccessRulesstring[]

Rules like organization, operator, user:<id>, api_key, api_key:<id>, clerk_session, or *

sendAccessRulesstring[]

Rules like organization, user:<id>, api_key, api_key:<id>, clerk_session, or *

Response

Inbox policy updated successfully

Changes

Changed in 1 of the 44 revisions of this API.1