API - Getting and modifying Lead tags

How to see what they are, remove and add a Lead's tags.

General Query Params

Key
Description

i

Identifier of your instance, subdomain

apitoken

API token

Getting instance tags

The request was sent using the software Postman. The expected response is a list of objects with the IDs and names of the tags in the instance.

GET /tags?apitoken=your-token&i=your-instance

Full endpoint: https://sprinthub-api-master.sprinthub.app/tags?apitoken=your-token&i=your-instance

Getting instance tags.

Getting current Lead tags

The expected response is a list with the tags attached to the Lead and their respective colors.

GET /leads/lead-id?query={tags{id,tag,color}}&apitoken=your-token&i=your-instance

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads/lead-id?query={tags{id,tag,color}}&apitoken=your-token&i=your-instance

Getting Lead tags

Modifying Lead tags

To modify tags, an overwrite method is used. The tag IDs sent in the request body will replace the lead's current tags. You must pass an object with the key tags which has as its value an array with the IDs.

PUT /leads/lead-id&apitoken=your-token&i=your-instance

Full endpoint: https://sprinthub-api-master.sprinthub.app/leads/lead-id&apitoken=your-token&i=your-instance

Modifying Lead tags.

Last updated

Was this helpful?