Add labels to an inbox thread

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

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.emailInboxes.threads.labels.create('inbox_id', 'thread_id', {
  labels: [],
});

console.log(response.data);

200

{
  "data": {
    "id": "33333333-3333-3333-3333-333333333333",
    "record_type": "email_thread",
    "inbox_id": "11111111-1111-1111-1111-111111111111",
    "labels": [
      "needs_review"
    ]
  }
}

Authorizations

Authorization · string · header · required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

inbox_id · string<uuid> · required

Email inbox UUID.

thread_id · string<uuid> · required

Thread UUID.

Body

application/json

Labels to add or remove. Both operations are idempotent set operations, so a retried request converges instead of failing.

labels · string[] · 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.

Required array length: 1 - 50 elements

Required string length: 1 - 255

Response

200

application/json

The thread identity and its current label set.

data · object · required

Show child attributes