Client Tags

This guide enables developers to interact with the Whautomate platform programmatically, offering endpoints designed to manage client tags efficiently.

Client tags are a crucial aspect of organizing and categorizing client information within the platform.

get

/v1/clientTags

Query parameters

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/clientTags' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "canonical": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

200 response

post

/v1/clientTags

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

canonicalstring

createdAtstring

updatedAtstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/clientTags' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

200

{
  "id": "text",
  "name": "text",
  "canonical": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

200 response

get

/v1/clientTags/{clientTagId}

Path parameters

clientTagIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/clientTags/{clientTagId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "name": "text",
  "canonical": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

200 response

delete

/v1/clientTags/{clientTagId}

Path parameters

clientTagIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://<YOUR HOST>/v1/clientTags/{clientTagId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response