Skip to content

Attributes

Dynamic attributes extend the standard lead schema with arbitrary custom fields. Five types are supported:

TypeUse forExample value
textSingle string values"Italian"
numberNumeric values (integer or float)500
boolTrue/false flagstrue
listArrays of strings["CRM", "ERP"]
objectNested key-value data{ "linkedin": "https://..." }

GET /leads/{id}/attributes

Response 200 OK:

[
{ "id": "uuid", "name": "industry", "type": "text", "value": "Software" },
{ "id": "uuid", "name": "employees", "type": "number", "value": 500 },
{ "id": "uuid", "name": "verified", "type": "bool", "value": true },
{ "id": "uuid", "name": "products", "type": "list", "value": ["CRM", "ERP"] },
{ "id": "uuid", "name": "social", "type": "object", "value": { "linkedin": "https://..." } }
]

POST /leads/{id}/attributes
{ "name": "cuisine", "type": "text", "value": "Italian" }

Response 201 Created: Full attribute object.


PUT /leads/{id}/attributes/{attr_id}
{ "value": "Mediterranean" }

Response 200 OK: Updated attribute object.


DELETE /leads/{id}/attributes/{attr_id}

Response 204 No Content.


Use attr:field_name in filter expressions:

Terminal window
?filter=and.eq.attr:cuisine.Italian
?filter=and.gt.attr:employees.100

See Filtering for all supported operators.