Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

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
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

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

Request-Body
application/json
accept_fromstring

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

Erlaubt:anyoneverifiedallowlist
allowliststring[]

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

max. 500 Elemente
owner_addressesstring[]

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

max. 50 Elemente
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

Erlaubt: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

max. 5 Elemente
Antworten
200

Safety rules

objectstringerforderlich
Erlaubt:inbox_safety
inbox_idstring<uuid>erforderlich
accept_fromstringerforderlich

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

Erlaubt:anyoneverifiedallowlist
allowliststring[]erforderlich

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

max. 500 Elemente
owner_addressesstring[]erforderlich

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

max. 50 Elemente
screeningbooleanerforderlich

Score external mail for prompt injection (agent inboxes only)

extract_codesbooleanerforderlich

Expose extracted codes and sign-in links

send_policystringerforderlich

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

Erlaubt:reply_onlyallowlistopen
require_approvalbooleanerforderlich

Every send waits for a person

private_codesbooleanerforderlich

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

send_capinteger | nullerforderlich

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

forward_tostring[]erforderlich

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

max. 5 Elemente
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Restricted API key or role

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
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"
  ]
}'
Antwort
{
  "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"
  ]
}

War diese Seite hilfreich?