WhatsAble
API v1Labels

Rename or change a label

patchhttps://api.whatsable.app/v1/labels/{id}
Build a request to copy

This page never sends a request. Fill in the fields, then copy the request and run it from your server.

Request
curl -X PATCH 'https://api.whatsable.app/v1/labels/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gold"
}'

Changes a label. A label limited to some numbers can be changed only by a key that may use all of them. An empty number_ids makes the label available on every number, so it needs a key that may use every number.

Authorization

bearerAuth
headerAuthorizationBearer <nfy_live_<32 characters>>

An API key from Settings > API keys, sent as Authorization: Bearer <key>.

Path Parameters

id*string

The label id.

Length1 <= length <= 64

Request Body

application/json
  1. body

The fields to change. Fields left out are kept.

name?string
Length1 <= length <= 60
color?string
Value in"label-1""label-2""label-3""label-4""label-5""label-6"
description?|null
keywords?array<>
Itemsitems <= 20
number_ids?array<>

Limit the label to these numbers. Empty or absent means every number.

Itemsitems <= 50

Response Body

The updated label.

application/json
  1. response

A label the organization tags contacts with.

object*string
id*string
Length1 <= length <= 64
name*string
color*string

One of six palette slots the dashboard draws.

Value in"label-1""label-2""label-3""label-4""label-5""label-6"
description*string|null
keywords*array<string>

Words that apply the label automatically to an inbound message, stored normalized.

number_ids*array<>

The numbers the label is limited to. Empty means every number.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.whatsable.app/v1/labels/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "Gold"}'
Example Response
{  "object": "label",  "id": "cm2v8l1a00001qz8h2b3c4d5e",  "name": "VIP",  "color": "label-2",  "description": "Customers with more than five orders",  "keywords": [    "vip"  ],  "number_ids": [],  "created_at": "2026-09-01T12:00:00Z",  "updated_at": "2026-09-01T12:00:00Z"}