Manage Labels in Chat

curl --request POST \
  --url https://{projectID}.texterchat.com/server/api/v2/chats/{chatId}/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add": [
    "manager",
    "VIP",
    "holiday"
  ]
}
'

"OK"

{
  "error": "data must match exactly one schema in oneOf"
}

{
  "error": "<string>"
}

POST

chats

{chatId}

labels

curl --request POST \
  --url https://{projectID}.texterchat.com/server/api/v2/chats/{chatId}/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add": [
    "manager",
    "VIP",
    "holiday"
  ]
}
'

"OK"

{
  "error": "data must match exactly one schema in oneOf"
}

{
  "error": "<string>"
}

Required token scopes: Manage all chats Using set overrides any existing labels on the chat and replaces them with the new list you provide. Passing "set": [] clears all labels from the chat.

Authorizations

Authorization

string

header

required

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

Path Parameters

chatId

string

required

The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the contact's phone number

Body

application/json

add

string[]

Label IDs to add to the chat

Minimum array length: 1

remove

string[]

Label IDs to remove from the chat

Minimum array length: 1

set

string[]

Label IDs that replace all existing labels. May be empty to clear all labels

Response

Labels updated. Body is the plain text OK

Getting Started

Endpoints

Webhooks

Objects

Manage Labels in Chat

Authorizations

Path Parameters

Body

Response