Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

Cuerpo de la solicitud
application/json
namestring
from_namestring

"" removes it. On the shared domain a new one may not imitate a brand, and it is reviewed first (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

Respuestas
200

Inbox updated

objectstringobligatorio
Valores permitidos:inbox
idstring<uuid>obligatorio
namestringobligatorio
email_addressstringobligatorio
domain_idstring<uuid>obligatorio

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

receiving_addressstring | nullobligatorio
from_namestring | nullobligatorio
unreadintegerobligatorio

Threads with an unread message

draftsintegerobligatorio

Unsent drafts

last_receivedstring | nullobligatorio
created_atstringobligatorio
updated_atstringobligatorio
kindstringobligatorio
Valores permitidos:agenthuman
sharedbooleanobligatorio

On the shared inbox domain

expires_atstring | nullobligatorio
quarantinedintegerobligatorio

Held messages not yet released

pending_approvalintegerobligatorio

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
503

A new from_name on the shared domain can't be reviewed right now; retry-after says when to try again

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
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"
}'
Respuesta
{
  "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
}

¿Te ha resultado útil esta página?