Update a thread
Mark every message read or unread, or move it to inbox, archive, spam or trash (moving out of trash restores it). Labels have their own routes: POST, PUT and DELETE /inboxes/{inbox_id}/threads/{thread_id}/labels.
PATCH
/inboxes/{inbox_id}/threads/{thread_id}Authorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Path parameters
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>requiredThe thread ID
Request body
application/jsonreadbooleanMarks every message read or unread
folderstringsent is assigned, never chosen
Allowed:
inboxarchivespamtrashResponses
200
Thread updated
objectstringrequiredAllowed:
inbox_threadidstring<uuid>requiredsubjectstring | nullrequiredfolderstringrequiredAllowed:
inboxarchivespamsenttrashlabelsobject[]requiredShow propertiesHide properties
Array of
objectidstring<uuid>requirednamestringrequiredcolorstringrequiredreadbooleanrequiredquarantinedintegerrequiredBillionSend extension: held messages; 0 for inbox-scoped keys
401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Inbox or thread not found
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired