Skip to main content

Contact Tags

Contact tags group inbox contacts for segments, broadcasts and automations. To tag a contact, use Add tags to a contact; these endpoints manage the list of tags itself.

API regionapi.whautomate.com

List contact tags​

GET /v1/contactTags

Lists the contact 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/contactTags?limit=3" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "fxuL6is4yA",
    "name": "lead",
    "canonical": "lead",
    "createdAt": "2026-10-29T11:43:28.242Z",
    "updatedAt": "2026-10-29T11:43:28.242Z"
  },
  {
    "id": "c21JPV0a5L",
    "name": "booking",
    "canonical": "booking",
    "createdAt": "2026-10-29T11:43:28.260Z",
    "updatedAt": "2026-10-29T11:43:28.260Z"
  }
]

Create a contact tag​

POST /v1/contactTags

Creates a contact 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/contactTags" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Corporate enquiry"
  }'
Response 201
{
  "id": "Kk6rwL3z45",
  "name": "Corporate enquiry",
  "createdAt": "2026-10-29T12:40:11.705Z",
  "canonical": "corporate enquiry",
  "updatedAt": "2026-10-29T12:40:11.705Z"
}

Get a contact tag​

GET /v1/contactTags/{contactTagId}

Gets one contact tag by id.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
contactTagIdstringrequired
Response 200
idstring
namestringrequired
canonicalstring
createdAtstring
updatedAtstring
Request
curl -X GET "https://api.whautomate.com/v1/contactTags/Kk6rwL3z45" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "Kk6rwL3z45",
  "name": "Corporate enquiry",
  "canonical": "corporate enquiry",
  "createdAt": "2026-10-29T12:40:11.705Z",
  "updatedAt": "2026-10-29T12:40:11.705Z"
}

Delete a contact tag​

DEL /v1/contactTags/{contactTagId}

Deletes a contact tag.

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