PlatformDocs

Tag leads

Group leads with your own tags, then filter by them or use them in automations.

Create tags and add them to or remove them from leads from your own code. Authenticated with ?privateKey=YOUR_KEY (see Authentication).

GET/v3/tagsList tags
POST/v3/tagsCreate a tag
POST/v3/leads/{leadId}/tags/{tagId}Tag a lead
DELETE/v3/leads/{leadId}/tags/{tagId}Remove a tag from a lead
PUT/v3/tags/{tagId}Update a tag
DELETE/v3/tags/{tagId}Delete a tag
GET
Parameters
Website IdWebsite id (24 hex characters) from list_websites.
curl -X GET "https://rest-dash.revealid.xyz/v3/tags?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
websiteId*string—any

Use case: Tag a lead from your CRM sync

Create the tag once with POST /v3/tags ({ "websiteId": …, "name": "Hot account", "color": "#059669" }; the name is stored as HOT ACCOUNT), then POST /v3/leads/{leadId}/tags/{tagId} for each lead. Adding a tag starts the website's automations that trigger on a tag being added. A lead that already has the tag answers Tag Id already exist.

Use case: Find tagged leads

GET /v3/leads?tag=HOT ACCOUNT filters by the tag's name, as GET /v3/tags lists it.

On this page