PATCH
/
v1
/
labels
/
{label_id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

label_id
string
required

Body

application/json
description
string

Help with website or app functionality, technical glitches, and navigation.

name
string

Name of the label.

shared_label_id
string

An identifier used to associate a channel_private label with a corresponding shared label within the organization, facilitating unified label management across different channels.

Response

200 - application/json
channel_id
string

The identifier of the channel this label is associated with, required for channel_private labels. This links the label to a specific communication channel.

created_at
string
required

The ISO 8601 time at which the Label was created.

description
string

An optional detailed description of the label, providing additional context about its purpose.

external_label_id
string

Identifier of the label in an external system, required for channel_private labels that map to external systems.

id
string
required

Unique identifier of the label.

name
string
required

The human-readable name of the label, used for easy identification. This name can be something descriptive related to the label's purpose, like 'Technical Support' or 'Urgent'.

shared_label_id
string

An identifier used to associate this channel_private label with a corresponding shared label within the organization, facilitating unified label management across different channels.

type
enum<string>
required

The type of the label, which determines its scope and usage. shared labels are accessible across multiple channels, while channel_private labels are restricted to a specific channel. Note: When a shared label is created and later applied to a conversation, the API automatically applies the corresponding channel_private label to the conversation in the specific channel, and vice versa.

Available options:
shared,
channel_private