Add labels to a thread
Puts 1-10 of the inbox’s labels on the thread and keeps the ones it has. If any label is unknown, nothing changes (404). Answers every label on the thread afterwards; one inbox.thread.labels.updated event reports the request.
POST
/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>[]required1-10 label IDs of the inbox
min items 1 · max items 10
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