# Clients

Explore the following functionalities to manage clients:

* **Add Client**: Create new clients within the platform, supplying the necessary client details via the designated endpoint.
* **Search Clients**: Retrieve clients based on specified parameters or keywords, allowing for efficient search capabilities.
* **Get Client by ID**: Fetch detailed information about a specific client using their unique identifier.
* **Update Client**: Modify and update client information, ensuring accurate and up-to-date records.
* **Add Client Tag**: Associate tags with clients, enabling categorization and streamlined organization.
* **Remove Client Tag**: Effortlessly remove tags associated with clients, facilitating flexible tag management.
* **Remove Client**: Delete clients from the platform, facilitating data management and organization.

{% openapi src="/files/XTQNERDWI4mzjpexowHX" path="/v1/clients" method="post" %}
[Whautomate DEV-Staging-swagger (3).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FahbEjyuebtOmryHRqI6G%2FWhautomate%20DEV-Staging-swagger%20\(3\).json?alt=media\&token=406b9827-f629-49a1-b059-306d5d56c418)
{% endopenapi %}

Search clients based on parameters

{% openapi src="/files/tfrMGAGmo2ZqmF0Snwt7" path="/v1/clients" method="get" %}
[Whautomate Rest API-Production-swagger.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FrzEnP2NfZ44XvfWCZUhV%2FWhautomate%20Rest%20API-Production-swagger.json?alt=media\&token=de5c290e-0ccd-422c-ba30-6871f7bace3d)
{% endopenapi %}

{% hint style="warning" %}
Please do note the **{clientId}** in the URL path denotes the UUID - **Id of the client**. 

E.g. 5tw9zcQkbu
{% endhint %}

{% openapi src="/files/XTQNERDWI4mzjpexowHX" path="/v1/clients/{clientId}" method="get" %}
[Whautomate DEV-Staging-swagger (3).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FahbEjyuebtOmryHRqI6G%2FWhautomate%20DEV-Staging-swagger%20\(3\).json?alt=media\&token=406b9827-f629-49a1-b059-306d5d56c418)
{% endopenapi %}

{% openapi src="/files/XTQNERDWI4mzjpexowHX" path="/v1/clients/{clientId}" method="put" %}
[Whautomate DEV-Staging-swagger (3).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FahbEjyuebtOmryHRqI6G%2FWhautomate%20DEV-Staging-swagger%20\(3\).json?alt=media\&token=406b9827-f629-49a1-b059-306d5d56c418)
{% endopenapi %}

{% openapi src="/files/XTQNERDWI4mzjpexowHX" path="/v1/clients/{clientId}" method="delete" %}
[Whautomate DEV-Staging-swagger (3).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FahbEjyuebtOmryHRqI6G%2FWhautomate%20DEV-Staging-swagger%20\(3\).json?alt=media\&token=406b9827-f629-49a1-b059-306d5d56c418)
{% endopenapi %}

{% openapi src="/files/tfrMGAGmo2ZqmF0Snwt7" path="/v1/clients/{clientId}/tags/add" method="post" %}
[Whautomate Rest API-Production-swagger.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FrzEnP2NfZ44XvfWCZUhV%2FWhautomate%20Rest%20API-Production-swagger.json?alt=media\&token=de5c290e-0ccd-422c-ba30-6871f7bace3d)
{% endopenapi %}

{% openapi src="/files/tfrMGAGmo2ZqmF0Snwt7" path="/v1/clients/{clientId}/tags/remove" method="post" %}
[Whautomate Rest API-Production-swagger.json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FrzEnP2NfZ44XvfWCZUhV%2FWhautomate%20Rest%20API-Production-swagger.json?alt=media\&token=de5c290e-0ccd-422c-ba30-6871f7bace3d)
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.whautomate.com/product-guides/whautomate-rest-api/clients.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.