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

List quarantine

BillionSend extension: the inbox’s held messages, newest first, metadata only. Not for inbox-scoped keys.

GET/inboxes/{inbox_id}/quarantine
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

Paramètres de requête
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Réponses
200

Held messages

objectstringrequis
Valeurs autorisées :list
has_morebooleanrequis
dataobject[]requis
Afficher les propriétés
Tableau de object
idstring<uuid>requis
thread_idstring<uuid> | nullrequis
fromstringrequis
subjectstring | nullrequis
received_atstringrequis
quarantine_reasonstringrequis
Valeurs autorisées :failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_cap
sender_truststringrequis
Valeurs autorisées :ownerallowlistedknown_threadexternalunauthenticatedfailed
injection_scoreinteger | nullrequis
phishing_scoreinteger | nullrequis
virus_signaturestring | nullrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Inbox or cursor 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
Requête
curl -X GET 'https://api.billionsend.com/inboxes/string/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "from": "string",
      "subject": "string",
      "received_at": "string",
      "quarantine_reason": "failed_auth",
      "sender_trust": "owner",
      "injection_score": 0,
      "phishing_score": 0,
      "virus_signature": "string"
    }
  ]
}

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