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

Query parameters

limitstringOptional

pagestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

get/v1/clientTags

GET /v1/clientTags HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

post

Header parameters

x-api-keystringRequired

Body

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

post/v1/clientTags

POST /v1/clientTags HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 84

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

200

200 response

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

get

Path parameters

clientTagIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

get/v1/clientTags/{clientTagId}

GET /v1/clientTags/{clientTagId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

delete

Path parameters

clientTagIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

successbooleanOptional

delete/v1/clientTags/{clientTagId}

DELETE /v1/clientTags/{clientTagId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}