Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

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

Request body
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

Responses
200

Inbox updated

objectstringrequired
Allowed:inbox
idstring<uuid>required
namestringrequired
email_addressstringrequired
domain_idstring<uuid>required

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

receiving_addressstring | nullrequired
from_namestring | nullrequired
unreadintegerrequired

Threads with an unread message

draftsintegerrequired

Unsent drafts

last_receivedstring | nullrequired
created_atstringrequired
updated_atstringrequired
kindstringrequired
Allowed:agenthuman
sharedbooleanrequired

On the shared inbox domain

expires_atstring | nullrequired
quarantinedintegerrequired

Held messages not yet released

pending_approvalintegerrequired

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
503

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
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"
}'
Response
{
  "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
}

Was this page helpful?