Set a thread's labels
Replaces the thread’s labels with exactly these (up to 100; [] takes them all off). The labels stay in the inbox. If any label is unknown, nothing changes (404). Answers every label on the thread afterwards.
PUT
/inboxes/{inbox_id}/threads/{thread_id}/labelsAuthorization
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
requiredapplication/jsonlabelsstring<uuid>[]requiredUp to 100 label IDs of the inbox: exactly the labels the thread ends up with
max items 100
Responses
200
The labels on the thread
objectstringrequiredAllowed:
listdataobject[]requiredEvery label on the thread after the change
Show propertiesHide properties
Array of
objectidstring<uuid>requirednamestringrequiredcolorstringrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Inbox, thread or label not found
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired