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.

GEThttps://<YOUR HOST>/v1/clientTags

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clientTags', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

POSThttps://<YOUR HOST>/v1/clientTags

Header parameters

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clientTags', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

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

GEThttps://<YOUR HOST>/v1/clientTags/{clientTagId}

Path parameters

clientTagId*string

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clientTags/{clientTagId}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

DELETEhttps://<YOUR HOST>/v1/clientTags/{clientTagId}

Path parameters

clientTagId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/clientTags/{clientTagId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}