Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

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

Corps de la requête
application/json
accept_fromstring

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

Valeurs autorisées :anyoneverifiedallowlist
allowliststring[]

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

max 500 éléments
owner_addressesstring[]

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

max 50 éléments
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

Valeurs autorisées :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 éléments
Réponses
200

Safety rules

objectstringrequis
Valeurs autorisées :inbox_safety
inbox_idstring<uuid>requis
accept_fromstringrequis

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

Valeurs autorisées :anyoneverifiedallowlist
allowliststring[]requis

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

max 500 éléments
owner_addressesstring[]requis

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

max 50 éléments
screeningbooleanrequis

Score external mail for prompt injection (agent inboxes only)

extract_codesbooleanrequis

Expose extracted codes and sign-in links

send_policystringrequis

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

Valeurs autorisées :reply_onlyallowlistopen
require_approvalbooleanrequis

Every send waits for a person

private_codesbooleanrequis

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

send_capinteger | nullrequis

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

forward_tostring[]requis

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

max 5 éléments
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key or role

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
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"
  ]
}'
Réponse
{
  "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"
  ]
}

Cette page vous a-t-elle été utile ?