跳到内容
Esc
↑↓导航↵打开⌘J预览

Update safety rules

BillionSend extension: any subset of the rules, merged over the stored ones. Needs the owner, admin or developer role, or a full access team key; inbox-scoped keys and MCP can’t change them.

PATCH/inboxes/{inbox_id}/safety
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

The inbox ID or its email address, such as support@example.com

请求体
application/json
accept_fromstring

Who may write in: anyone; verified (DMARC-aligned senders, known threads, the allowlist); allowlist only. Mail that fails is quarantined.

允许值:anyoneverifiedallowlist
allowliststring[]

"local@domain" (exact) or "*@domain" (the domain and its subdomains). On the shared domain it only lets mail in

最多 500 项
owner_addressesstring[]

Owners besides the team members' login addresses; ignored on the shared domain

最多 50 项
screeningboolean

Score external mail for prompt injection (agent inboxes only)

extract_codesboolean

Expose extracted codes and sign-in links

send_policystring

What the inbox may send without a person's approval. On the shared domain "allowlist" answers 422, and so does "open" unless the team is on a paid plan and past its first sends

允许值:reply_onlyallowlistopen
require_approvalboolean

Every send waits for a person

private_codesboolean

Received codes and sign-in links can't be sent on to anyone but owners

send_capinteger | null

Unattended recipients per UTC day; null: no cap. 1-50 on the shared domain

forward_tostring[]

Forward every delivered message to these team member or owner addresses; team members only on the shared domain

最多 5 项
响应
200

Safety rules

objectstring必填
允许值:inbox_safety
inbox_idstring<uuid>必填
accept_fromstring必填

Who may write in: anyone; verified (DMARC-aligned senders, known threads, the allowlist); allowlist only. Mail that fails is quarantined.

允许值:anyoneverifiedallowlist
allowliststring[]必填

"local@domain" (exact) or "*@domain" (the domain and its subdomains). On the shared domain it only lets mail in

最多 500 项
owner_addressesstring[]必填

Owners besides the team members' login addresses; ignored on the shared domain

最多 50 项
screeningboolean必填

Score external mail for prompt injection (agent inboxes only)

extract_codesboolean必填

Expose extracted codes and sign-in links

send_policystring必填

What the inbox may send without a person's approval. On the shared domain "allowlist" answers 422, and so does "open" unless the team is on a paid plan and past its first sends

允许值:reply_onlyallowlistopen
require_approvalboolean必填

Every send waits for a person

private_codesboolean必填

Received codes and sign-in links can't be sent on to anyone but owners

send_capinteger | null必填

Unattended recipients per UTC day; null: no cap. 1-50 on the shared domain

forward_tostring[]必填

Forward every delivered message to these team member or owner addresses; team members only on the shared domain

最多 5 项
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Restricted API key or role

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求体application/json
请求
curl -X PATCH 'https://api.billionsend.com/inboxes/string/safety' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accept_from": "anyone",
  "allowlist": [
    "string"
  ],
  "owner_addresses": [
    "string"
  ],
  "screening": true,
  "extract_codes": true,
  "send_policy": "reply_only",
  "require_approval": true,
  "private_codes": true,
  "send_cap": 0,
  "forward_to": [
    "string"
  ]
}'
响应
{
  "object": "inbox_safety",
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
  "accept_from": "anyone",
  "allowlist": [
    "string"
  ],
  "owner_addresses": [
    "string"
  ],
  "screening": true,
  "extract_codes": true,
  "send_policy": "reply_only",
  "require_approval": true,
  "private_codes": true,
  "send_cap": 0,
  "forward_to": [
    "string"
  ]
}

这个页面有帮助吗?