# 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="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FAR8RleQUykBRgXfltbDv%2Fartigo-1.png?alt=media&#x26;token=2f47914f-45a3-4fe3-9a87-04686d20c971" 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="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FrWaJA3qZNj81MH11cz60%2Fartigo-2.png?alt=media&#x26;token=57158e5c-3149-4e4c-8c3c-a3e6de8a4a40" 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="https://3534414179-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FT2skmDjVrbhZRHEQlNDj%2Fartigo-3.png?alt=media&#x26;token=44a5d89d-4cf7-4eca-8bcd-3911cc182e4f" alt=""><figcaption><p><em>Modificando as tags do Lead.</em></p></figcaption></figure>