Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

Cuerpo de la solicitud
application/json
accept_fromstring

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

Valores permitidos:anyoneverifiedallowlist
allowliststring[]

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

máx. 500 elementos
owner_addressesstring[]

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

máx. 50 elementos
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

Valores permitidos: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

máx. 5 elementos
Respuestas
200

Safety rules

objectstringobligatorio
Valores permitidos:inbox_safety
inbox_idstring<uuid>obligatorio
accept_fromstringobligatorio

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

Valores permitidos:anyoneverifiedallowlist
allowliststring[]obligatorio

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

máx. 500 elementos
owner_addressesstring[]obligatorio

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

máx. 50 elementos
screeningbooleanobligatorio

Score external mail for prompt injection (agent inboxes only)

extract_codesbooleanobligatorio

Expose extracted codes and sign-in links

send_policystringobligatorio

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

Valores permitidos:reply_onlyallowlistopen
require_approvalbooleanobligatorio

Every send waits for a person

private_codesbooleanobligatorio

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

send_capinteger | nullobligatorio

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

forward_tostring[]obligatorio

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

máx. 5 elementos
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key or role

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
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"
  ]
}'
Respuesta
{
  "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"
  ]
}

¿Te ha resultado útil esta página?