API - Obtendo e modificando tags do Lead

Como ver quais são, remover e adicionar as tags de um Lead.

Query Params gerais

Key/ChaveDescrição

i

Identificador da sua instância, subdomínio

apitoken

Token da API

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.

GET /tags?apitoken=seu-token&i=sua-instancia

Endpoint completo: https://sprinthub-api-master.sprinthub.app/tags?apitoken=seu-token&i=sua-instancia

Obtendo tags atuais do Lead

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

GET /leads/id-do-lead?query={tags{id,tag,color}}&apitoken=seu-token&i=sua-instancia

Endpoint completo: https://sprinthub-api-master.sprinthub.app/leads/id-do-lead?query={tags{id,tag,color}}&apitoken=seu-token&i=sua-instancia

Modificando as tags do Lead

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.

PUT /leads/id-do-lead&apitoken=seu-token&i=sua-instancia

Endpoint completo: https://sprinthub-api-master.sprinthub.app/leads/id-do-lead&apitoken=seu-token&i=sua-instancia

Last updated