API Reference

Dynamic Tags

Saved Smart Filter definitions used by Profile → Tags.

Dynamic tags are definitions

/v1/dynamic-tags manages saved filter definitions. Static assignments to individual entities continue to use /v1/tags. Reads require tags:read; writes require tags:write. Live keys are required.

List Dynamic Tags

GET/v1/dynamic-tags0 credits

Parameter	Type	Description
`page`	integer	Zero-indexed page.
`page_size`	integer	Number of definitions to return.
`search`	string	Case-insensitive name search.

bash

curl -H "Authorization: Bearer ss_live_..." \
  "https://api.hillwinds.ai/v1/dynamic-tags?search=renewal"

Create Dynamic Tag

POST/v1/dynamic-tags0 credits

Parameter	Type	Description
`name`required	string	Display name.
`entity_type`required	string	company, broker, or personnel.
`filter_def`required	object	Smart Filter definition whose query filters match entity_type.
`color_index`	integer	Optional UI color index.

json

{
  "name": "California healthcare",
  "entity_type": "company",
  "filter_def": {
    "entity_type": "company",
    "query": {
      "filters": {
        "states": ["CA"],
        "industries": ["Healthcare"]
      }
    }
  },
  "color_index": 3
}

Read, Update, or Delete

GET/v1/dynamic-tags/{id}0 credits

PATCH/v1/dynamic-tags/{id}0 credits

DELETE/v1/dynamic-tags/{id}0 credits

GET returns one owned definition. PATCH accepts a non-empty subset of name, entity_type, filter_def, and color_index and refreshes the platform definition cache. DELETE removes only the dynamic definition; unrelated static tag assignments are preserved.

PreviousTags Next Writing

Need a key?

Keys are issued by our team, not a signup form. Book a 25-minute walkthrough and you'll leave with sandbox and live credentials.

Get access Explore the platform