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}AuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
inbox_idstringrequisThe 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 (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
objectstringrequisinboxidstring<uuid>requisnamestringrequisemail_addressstringrequisdomain_idstring<uuid>requisA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullrequisfrom_namestring | nullrequisunreadintegerrequisThreads with an unread message
draftsintegerrequisUnsent drafts
last_receivedstring | nullrequiscreated_atstringrequisupdated_atstringrequiskindstringrequisagenthumansharedbooleanrequisOn the shared inbox domain
expires_atstring | nullrequisquarantinedintegerrequisHeld messages not yet released
pending_approvalintegerrequisDrafts waiting for a person
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisNot found
statusCodenumberrequisnamestringrequismessagestringrequisValidation error
statusCodenumberrequisnamestringrequismessagestringrequisToo many names reviewed or refused on the shared domain today, or the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequisA new from_name on the shared domain can't be reviewed right now; retry-after says when to try again
statusCodenumberrequisnamestringrequismessagestringrequis