Skip to main content

Client Tags

Client tags group clients for segments, broadcasts and automations. To tag a client, use Add tags to a client; these endpoints manage the list of tags itself. Creating and deleting tags needs the CRM Suite add-on.

API regionapi.whautomate.com

List client tags​

GET /v1/clientTags

Lists the client tags of the account.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitinteger
Results per page (default 10, max 100).
pageinteger
Page number, from 1 (default 1).
searchTextstring
Text to search for.
Response 200
idstring
namestringrequired
canonicalstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/clientTags?limit=3" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "2JovXi1PsQ",
    "name": "VIP",
    "canonical": "vip",
    "createdAt": "2026-10-29T11:42:19.115Z",
    "updatedAt": "2026-10-29T11:42:19.115Z"
  },
  {
    "id": "FK74CHoHEr",
    "name": "Member",
    "canonical": "member",
    "createdAt": "2026-10-29T11:42:19.130Z",
    "updatedAt": "2026-10-29T11:42:19.130Z"
  }
]

Create a client tag​

POST /v1/clientTags

Creates a client tag.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
namestringrequired
canonicalstring
createdAtstring
updatedAtstring
Response 200
idstring
namestringrequired
canonicalstring
createdAtstring
updatedAtstring
Request
curl -X POST "https://api.whautomate.com/v1/clientTags" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Referred by a friend"
  }'
Response 201
{
  "id": "y8FlWoC9qu",
  "name": "Referred by a friend",
  "createdAt": "2026-10-29T12:40:10.494Z",
  "canonical": "referred by a friend",
  "updatedAt": "2026-10-29T12:40:10.494Z"
}

Get a client tag​

GET /v1/clientTags/{clientTagId}

Gets one client tag by id.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientTagIdstringrequired
Response 200
idstring
namestringrequired
canonicalstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/clientTags/y8FlWoC9qu" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "y8FlWoC9qu",
  "name": "Referred by a friend",
  "canonical": "referred by a friend",
  "createdAt": "2026-10-29T12:40:10.494Z",
  "updatedAt": "2026-10-29T12:40:10.494Z"
}

Delete a client tag​

DEL /v1/clientTags/{clientTagId}

Deletes a client tag.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientTagIdstringrequired
Response 200
successboolean
Request
curl -X DELETE "https://api.whautomate.com/v1/clientTags/y8FlWoC9qu" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "success": true
}
Last updated on