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

Release an email

BillionSend extension: delivers a held message to the inbox. Mail held before screening ran (not_allowlisted, unauthenticated_sender, failed_auth) is screened first when screening can run, and stays held when the judge scores it at 80 or more (409 held_by_screening); otherwise it is never screened again. trust_sender also adds the sender to the allowlist, only for mail held as not_allowlisted from a verified (external) sender. MCP connections release for an agent: never mail held for prompt injection, phishing, a virus or failed authentication (403 forbidden), and any other hold only once screening, run at every MCP release, scores it under 80; while screening can’t run, nothing is released (503 screening_unavailable). Not for inbox-scoped keys.

POST/inboxes/{inbox_id}/quarantine/{email_id}/release
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

email_idstring<uuid>obrigatório

The received email's ID

Corpo da requisição
application/json
trust_senderboolean

Also add the sender's address to the inbox allowlist

Respostas
200

Released

objectstringobrigatório
Valores permitidos:inbox_release
inbox_idstring<uuid>obrigatório
email_idstring<uuid>obrigatório
released_atstringobrigatório
trusted_senderstring | nullobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Restricted API key, trust_sender refused, or an MCP connection releasing mail held for its content

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found or not quarantined

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
409

Screening held it again: it stays in quarantine

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error, or the allowlist is full

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
503

An MCP connection's release while screening can't run; retry-after says when to try again

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Corpoapplication/json
Requisição
curl -X POST 'https://api.billionsend.com/inboxes/string/quarantine/497f6eca-6276-4993-bfeb-53cbbbba6f08/release' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "trust_sender": true
}'
Resposta
{
  "object": "inbox_release",
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
  "email_id": "8e6bf5ae-e456-4654-87f8-33e2156caffc",
  "released_at": "string",
  "trusted_sender": "string"
}

Esta página foi útil?