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

Update an inbox

Its name or from_name; BillionSend extension: expires_in, a new lifetime counted from now. On a shared-domain inbox a new from_name is reviewed first (503 while that review is unavailable). Returns the full inbox.

PATCH/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

Corpo da requisição
application/json
namestring
from_namestring

"" removes it. On the shared domain a new one may not imitate a brand, and it is reviewed first where the instance reviews names (503 with retry-after while that review is unavailable).

expires_instring | null

BillionSend extension: a new lifetime counted from now, "1h" to "365d"; null never expires

Respostas
200

Inbox updated

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

Too many names reviewed or refused on the shared domain today, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
503

A new from_name on the shared domain can't be reviewed right now; 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 PATCH 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "from_name": "string",
  "expires_in": "string"
}'
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?