# API - Obtendo e modificando tags do Lead

### Query Params gerais

<table><thead><tr><th width="291">Key/Chave</th><th width="450">Descrição</th></tr></thead><tbody><tr><td>i</td><td>Identificador da sua instância, subdomínio </td></tr><tr><td>apitoken</td><td>Token da API</td></tr></tbody></table>

## Obtendo tags da instância

O envio da requisição foi feito utilizando o software *Postman*. A resposta esperada é uma lista de objetos com os IDs e nomes das tags na instância.

<mark style="color:green;">`GET`</mark> `/tags?apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/tags?apitoken=seu-token\\&i=sua-instancia></mark>

<figure><img src="/files/G0UK27X7FuvxhJDdZoGb" alt=""><figcaption><p><em>Obtendo tags da instância.</em></p></figcaption></figure>

## Obtendo tags atuais do Lead

A resposta esperada é uma lista com as tags atreladas ao Lead e suas respectivas cores.

<mark style="color:green;">`GET`</mark> `/leads/id-do-lead?query={tags{id,tag,color}}&apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/leads/id-do-lead?query={tags{id,tag,color\\}}\\&apitoken=seu-token\\&i=sua-instancia></mark>

<figure><img src="/files/5fs5mgfCEINLemtzFgrt" alt=""><figcaption><p><em>Obtendo tags do Lead</em></p></figcaption></figure>

## Modificando as tags do Lead&#x20;

Para modificar as tags, faz-se uma forma de sobrescrita. Os IDs das tags passados no corpo da requisição substituirão as tags atuais do lead. Deve-se passar um objeto com a chave `tags` que possui como valor um array com os IDs.

<mark style="color:green;">`PUT`</mark> `/leads/id-do-lead&apitoken=seu-token&i=sua-instancia`

Endpoint completo: <mark style="color:green;"><https://sprinthub-api-master.sprinthub.app/leads/id-do-lead\\&apitoken=seu-token\\&i=sua-instancia></mark>

<figure><img src="/files/o95AuMZvszxobiXRMHoU" alt=""><figcaption><p><em>Modificando as tags do Lead.</em></p></figcaption></figure>


---

# 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://docs.sprinthub.com/topicos/api/api-obtendo-e-modificando-tags-do-lead.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.
