Skip to main content
PUT
/
mail
/
v1
/
inboxes
/
{inboxId}
/
policy
Set inbox mail policy
curl --request PUT \
  --url https://api.case.dev/mail/v1/inboxes/{inboxId}/policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enforceSenderAllowlist": true,
  "allowedSenderPatterns": [
    "<string>"
  ],
  "readAccessRules": [
    "<string>"
  ],
  "replyAccessRules": [
    "<string>"
  ],
  "sendAccessRules": [
    "<string>"
  ]
}
'

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

inboxId
string
required

Body

application/json
enforceSenderAllowlist
boolean
allowedSenderPatterns
string[]

Exact emails, @domain rules, or *

readAccessRules
string[]

Rules like organization, operator, user:, api_key, api_key:, clerk_session, or *

replyAccessRules
string[]

Rules like organization, operator, user:, api_key, api_key:, clerk_session, or *

sendAccessRules
string[]

Rules like organization, user:, api_key, api_key:, clerk_session, or *

Response

Inbox policy updated successfully