Email Inboxes

Add labels to an inbox thread

Changed on

Adds one or more mutable labels to a thread, letting an agent mark a whole conversation (for example needs_review) without labelling each message individually.

Thread labels are independent of message labels: labelling a thread does not label its messages, and labelling a message does not label its thread. Idempotent and case-sensitive.

post/email_inboxes/{inbox_id}/threads/{thread_id}/labels

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/email_inboxes/{inbox_id}/threads/{thread_id}/labels
  • Auth
    HTTP bearer

Path parameters

inbox_idstring uuid required

Email inbox UUID.

thread_idstring uuid required

Thread UUID.

Request body

labelsstring[] required

One or more labels. Each label is a freeform, case-sensitive string of at most 255 characters; a message or thread may carry at most 50 labels. The telnyx: prefix is a reserved system namespace and is rejected on customer writes.

Response

The thread identity and its current label set.

Changes