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

Retrieve an inbox

By id, or by its email address (case-insensitive). An expired inbox is not found.

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

Inbox

objectstringobrigatório
Valores permitidos:inbox
idstring<uuid>obrigatório
namestringobrigatório
email_addressstringobrigatório
domain_idstring<uuid>obrigatório

A shared address's is its team's shared subdomain: the GET /domains row with shared: true

receiving_addressstring | nullobrigatório
from_namestring | nullobrigatório
unreadintegerobrigatório

Threads with an unread message

draftsintegerobrigatório

Unsent drafts

last_receivedstring | nullobrigatório
created_atstringobrigatório
updated_atstringobrigatório
kindstringobrigatório
Valores permitidos:agenthuman
sharedbooleanobrigatório

On the shared inbox domain

expires_atstring | nullobrigatório
quarantinedintegerobrigatório

Held messages not yet released

pending_approvalintegerobrigatório

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "inbox",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "email_address": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "receiving_address": "string",
  "from_name": "string",
  "unread": 0,
  "drafts": 0,
  "last_received": "string",
  "created_at": "string",
  "updated_at": "string",
  "kind": "agent",
  "shared": true,
  "expires_at": "string",
  "quarantined": 0,
  "pending_approval": 0
}

Esta página foi útil?