> For the complete documentation index, see [llms.txt](https://help.whautomate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.whautomate.com/product-guides/whautomate-rest-api/contacts.md).

# Contacts

**Search Contacts:** Search and retrieve contacts based on specified parameters or keywords, enabling efficient categorization and retrieval.

**Add Contact:** Create and add new contacts to the platform by providing the necessary contact details via this endpoint.

**Get Contact By Id:** Retrieve detailed information about a specific contact using its unique identifier (`contactId`).

**Delete Contact:** Delete a specific contact from the platform, identified by its unique identifier (`contactId`).

**Update Contact:** Modify and update contact information for a specific contact identified by its unique identifier (`contactId`).

**Add Tag to Contact:** Associate tags with a specific contact, enhancing categorization and triggering automations.

**Remove Tag from Contact:** Effortlessly remove tags associated with a specific contact, facilitating flexible tag management.

{% openapi src="/files/QSZymFdMhQKJhEnhPRb1" path="/v1/contacts" method="get" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FhcITwLqllLFuGwvGf1mM%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=73c2e61f-1094-4e75-a6de-9d72908a4f00)
{% endopenapi %}

{% openapi src="/files/QSZymFdMhQKJhEnhPRb1" path="/v1/contacts" method="post" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FhcITwLqllLFuGwvGf1mM%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=73c2e61f-1094-4e75-a6de-9d72908a4f00)
{% endopenapi %}

{% openapi src="/files/QSZymFdMhQKJhEnhPRb1" path="/v1/contacts/{contactId}" method="get" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FhcITwLqllLFuGwvGf1mM%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=73c2e61f-1094-4e75-a6de-9d72908a4f00)
{% endopenapi %}

{% openapi src="/files/QSZymFdMhQKJhEnhPRb1" path="/v1/contacts/{contactId}" method="delete" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FhcITwLqllLFuGwvGf1mM%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=73c2e61f-1094-4e75-a6de-9d72908a4f00)
{% endopenapi %}

{% openapi src="/files/QSZymFdMhQKJhEnhPRb1" path="/v1/contacts/{contactId}" method="put" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FhcITwLqllLFuGwvGf1mM%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=73c2e61f-1094-4e75-a6de-9d72908a4f00)
{% endopenapi %}

{% openapi src="/files/gB9ZrNbC1wMOrgdwXnSz" path="/v1/contacts/{contactId}/tags/add" method="post" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FKZ2LMuDJvx85hp39M31P%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=5f85adc6-b154-4913-918d-fcea6e72733e)
{% endopenapi %}

{% openapi src="/files/gB9ZrNbC1wMOrgdwXnSz" path="/v1/contacts/{contactId}/tags/remove" method="post" %}
[Whautomate Rest API-Production-oas30 (2).json](https://810714386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF8vuadG7OJ1fFdSBZATv%2Fuploads%2FKZ2LMuDJvx85hp39M31P%2FWhautomate%20Rest%20API-Production-oas30%20\(2\).json?alt=media\&token=5f85adc6-b154-4913-918d-fcea6e72733e)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
