> For the complete documentation index, see [llms.txt](https://docs.coretalk.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coretalk.com.br/api/api/contatos.md).

# 👤 Contatos

## BlockContact

> Bloqueia contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/blockContact":{"post":{"summary":"BlockContact","operationId":"BlockContact","description":"Bloqueia contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## CreateContact

> Cria um novo contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/createContact":{"post":{"summary":"CreateContact","operationId":"CreateContact","description":"Cria um novo contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## GetContactExtraInfo

> Obtém contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/getContactExtraInfo":{"get":{"summary":"GetContactExtraInfo","operationId":"GetContactExtraInfo","description":"Obtém contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}},{"name":"contactId","in":"query","description":"ID do contato","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}}}}}}
```

## SearchContacts

> Pesquisa contatos.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/contacts/search":{"post":{"summary":"SearchContacts","operationId":"SearchContacts","description":"Pesquisa contatos.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## ShowContact

> Exibe detalhes de contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/showcontact":{"post":{"summary":"ShowContact","operationId":"ShowContact","description":"Exibe detalhes de contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## UpdateContact

> Atualiza os dados de contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/updateContact":{"post":{"summary":"UpdateContact","operationId":"UpdateContact","description":"Atualiza os dados de contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## UpdateContactExtraInfo

> Atualiza os dados de contato.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/updateContactExtraInfo":{"post":{"summary":"UpdateContactExtraInfo","operationId":"UpdateContactExtraInfo","description":"Atualiza os dados de contato.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## UpdateContactKanban

> Atualiza os dados de contato de kanban.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/updateContactKanban":{"post":{"summary":"UpdateContactKanban","operationId":"UpdateContactKanban","description":"Atualiza os dados de contato de kanban.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```

## UpdateContactWallet

> Atualiza os dados de contato de carteira.

```json
{"openapi":"3.0.3","info":{"title":"Postman v3","version":"1.0.0"},"tags":[{"name":"👤 Contatos","description":""}],"servers":[{"url":"https://{BaseUrl}/v2/api/external/{ApiID}","description":"Servidor da API","variables":{"BaseUrl":{"default":"api.example.com","description":"URL base da API"},"ApiID":{"default":"seu-api-id","description":"ID da sua API"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Header de autenticação Bearer no formato Bearer <token>"}}},"paths":{"/v2/api/external/{ApiID}/updateContactWallet":{"post":{"summary":"UpdateContactWallet","operationId":"UpdateContactWallet","description":"Atualiza os dados de contato de carteira.","tags":["👤 Contatos"],"parameters":[{"name":"ApiID","in":"path","required":true,"description":"Identificador do recurso (ApiID)","schema":{"type":"string"}}],"responses":{"200":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Requisição inválida"},"401":{"description":"Não autorizado — token Bearer ausente ou inválido"},"403":{"description":"Acesso negado"},"404":{"description":"Recurso não encontrado"},"500":{"description":"Erro interno do servidor"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
```


---

# 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://docs.coretalk.com.br/api/api/contatos.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.
