Update a lead property

PATCH

/api/v1/lead-properties/{key}

key

required

string

Property key

typeoptional

"string" | "number" | "boolean" | "date"

How values are compared when filtering. Values are always stored as text; the type is guessed from the first value seen and can be changed.

showAsColumnoptional

boolean

Show this property as a column in the leads table.

200The updated property.

property

object

key	string Property key. Filter on it as properties.<key>.
type	"string" \| "number" \| "boolean" \| "date" How values are compared when filtering. Values are always stored as text; the type is guessed from the first value seen and can be changed.
showAsColumn	boolean Shown as a column in the leads table.
leadCount	integer Leads with a non-empty value.
topValues	object[] Up to 5 most common values, most common first.

requestId

string · uuid

Id of this request, for support and troubleshooting

Search docs