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.
/inboxes/{inbox_id}AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
application/jsonnamestringfrom_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 | nullBillionSend extension: a new lifetime counted from now, "1h" to "365d"; null never expires
Inbox updated
objectstringrequiredinboxidstring<uuid>requirednamestringrequiredemail_addressstringrequireddomain_idstring<uuid>requiredA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullrequiredfrom_namestring | nullrequiredunreadintegerrequiredThreads with an unread message
draftsintegerrequiredUnsent drafts
last_receivedstring | nullrequiredcreated_atstringrequiredupdated_atstringrequiredkindstringrequiredagenthumansharedbooleanrequiredOn the shared inbox domain
expires_atstring | nullrequiredquarantinedintegerrequiredHeld messages not yet released
pending_approvalintegerrequiredDrafts waiting for a person
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredToo many names reviewed or refused on the shared domain today, or the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequiredA new from_name on the shared domain can't be reviewed right now; retry-after says when to try again
statusCodenumberrequirednamestringrequiredmessagestringrequired