Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Get safety rules

BillionSend extension: who may write in, screening, code extraction, what the inbox may send and where it forwards.

GET/inboxes/{inbox_id}/safety
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
inbox_idstringobrigatório

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

Respostas
200

Safety rules

objectstringobrigatório
Valores permitidos:inbox_safety
inbox_idstring<uuid>obrigatório
accept_fromstringobrigatório

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

Valores permitidos:anyoneverifiedallowlist
allowliststring[]obrigatório

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

máx. 500 itens
owner_addressesstring[]obrigatório

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

máx. 50 itens
screeningbooleanobrigatório

Score external mail for prompt injection (agent inboxes only)

extract_codesbooleanobrigatório

Expose extracted codes and sign-in links

send_policystringobrigatório

What the inbox may send without a person's approval. On the shared domain "allowlist" answers 422, and so does "open" unless the instance lets the team start conversations there (paid plans only)

Valores permitidos:reply_onlyallowlistopen
require_approvalbooleanobrigatório

Every send waits for a person

private_codesbooleanobrigatório

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

send_capinteger | nullobrigatório

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

forward_tostring[]obrigatório

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

máx. 5 itens
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/inboxes/string/safety' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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"
  ]
}

Esta página foi útil?