API ReferenceInboxesThreads

Update Thread

Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a 422 for threads with 100 or more messages.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.
thread_idstringRequired
ID of thread.

Request

This endpoint expects an object.
add_labelslist of stringsOptional
Labels to add to thread. Cannot be system labels.
remove_labelslist of stringsOptional

Labels to remove from thread. Cannot be system labels. Takes priority over add_labels (in the event of duplicate labels passed in).

Response

This endpoint returns an object.
thread_idstring
ID of thread.
labelslist of strings
Labels of thread.

Errors

400
Validation Error
404
Not Found Error
422
Unprocessable Error