TCN API

CreateLabel

POST

https://api.cbf.tcn.com/api/v1alpha1/org/labels/createlabel

LabelsService

CreateLabel creates a new label.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the CreateLabel rpc.

label

object (Label)

label

optional

The label object that will be created

org_id

string

org_id

optional

labels are owned by orgs. this
could be nasty in regards to
org trusts and groups.

name

string

name

optional

simply the name of the label.
'Team A', 'Medical', etc

description

string

description

optional

the description of the label.

color

string

color

optional

Hex color code of the label.

label_id

string

label_id

optional

Id of the label.

deleted

boolean

deleted

optional

whether or not the label is deleted.

Example

{
  "label": {
    "org_id": "string",
    "name": "string",
    "description": "string",
    "color": "string",
    "label_id": "string",
    "deleted": true
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/org/labels/createlabel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "label": {
        "org_id": "string",
        "name": "string",
        "description": "string",
        "color": "string",
        "label_id": "string",
        "deleted": true
    }
}'

Responses

🟢200OK

application/json

Success

Body

Response message for the CreateLabel rpc.

label_id

string

label_id

optional

The ID of the created label

Example

{
  "label_id": "string"
}

🔴500Server Error

Modified at 2025-04-18 19:29:54

DeliverReceipt

GetLabel