Projects
Events
Campaigns
Subscriptions
Journeys
Templates
Contacts
API keys
curl --request POST \
--url https://apix.spotzee.com/api/client/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "High-value customers",
"type": "dynamic",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"children": "<array>"
}
}
'{
"id": 91,
"project_id": 42,
"name": "Newsletter subscribers — Q2 2026",
"type": "static",
"state": "draft",
"version": 3,
"is_visible": true,
"created_at": "<string>",
"updated_at": "<string>",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"frequency": {
"period": {
"type": "rolling",
"unit": "hour",
"value": 123
},
"operator": "=",
"count": 123
},
"children": "<array>"
},
"rule_id": 123,
"users_count": 12584,
"tags": [
"<string>"
],
"refreshed_at": "<string>"
}Create a list
Creates a new static or dynamic list. Static lists are populated by adding members directly. Dynamic lists are materialised from a rule tree and refreshed when contacts change.
curl --request POST \
--url https://apix.spotzee.com/api/client/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "High-value customers",
"type": "dynamic",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"children": "<array>"
}
}
'{
"id": 91,
"project_id": 42,
"name": "Newsletter subscribers — Q2 2026",
"type": "static",
"state": "draft",
"version": 3,
"is_visible": true,
"created_at": "<string>",
"updated_at": "<string>",
"rule": {
"uuid": "b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91",
"type": "wrapper",
"group": "user",
"path": "data.country",
"operator": "<string>",
"id": 123,
"root_uuid": "<string>",
"parent_uuid": "<string>",
"value": "<string>",
"frequency": {
"period": {
"type": "rolling",
"unit": "hour",
"value": 123
},
"operator": "=",
"count": 123
},
"children": "<array>"
},
"rule_id": 123,
"users_count": 12584,
"tags": [
"<string>"
],
"refreshed_at": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Body
- Option 1
- Option 2
Create a new list. The type discriminator chooses between dynamic (rule-driven) and static (manual) membership.
Human-readable list name.
1"High-value customers"
dynamic Membership rule tree. Members are materialised from this rule.
Hide child attributes
Hide child attributes
Stable client-supplied UUID for this rule node — preserved across edits.
"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91"
Type of value the rule node holds. wrapper is a logical group; the rest are leaf comparisons.
wrapper, string, number, boolean, date, array, shopify_purchase Where the rule applies — to the contact (user), an event (event), or inherited from the parent wrapper.
user, event, parent Dotted path on the contact or event payload. For wrappers, leave empty.
"data.country"
Comparison or logical operator. See RuleOperator for the canonical list.
Internal numeric identifier of a persisted rule node. Omit on create.
UUID of the root wrapper of the rule tree this node belongs to.
UUID of the immediate parent wrapper.
Right-hand side of a leaf comparison. Omitted on wrapper nodes.
Required event count and operator over a time period — used by event-frequency rules.
Hide child attributes
Hide child attributes
Time window for an event-frequency rule — rolling (relative) or fixed (absolute).
=, <, <=, >, >= Nested rule nodes — present on wrapper types.
Tags applied to the list. Used for organisation and filtering.
When true, the list appears in the in-product UI list directory.
Response
The newly created list.
A static or dynamic group of contacts. Used to send campaigns and as a segment input.
Numeric list identifier.
91
Identifier of the project the list belongs to.
42
Human-readable list name.
"Newsletter subscribers — Q2 2026"
A static list has explicit members. A dynamic list is materialised from a rule tree.
static, dynamic Current list state. loading while a refresh is in progress; ready once members are materialised.
draft, ready, loading Monotonically incrementing version. Bumped on rule edits.
3
Whether the list is shown in the in-product UI list directory.
Time the list was created. ISO 8601.
Time the list was last modified. ISO 8601.
Membership rule tree for dynamic lists. Absent on static lists.
Hide child attributes
Hide child attributes
Stable client-supplied UUID for this rule node — preserved across edits.
"b1f4a2c8-3d9e-4a1b-9b3a-1f0c8d4e2a91"
Type of value the rule node holds. wrapper is a logical group; the rest are leaf comparisons.
wrapper, string, number, boolean, date, array, shopify_purchase Where the rule applies — to the contact (user), an event (event), or inherited from the parent wrapper.
user, event, parent Dotted path on the contact or event payload. For wrappers, leave empty.
"data.country"
Comparison or logical operator. See RuleOperator for the canonical list.
Internal numeric identifier of a persisted rule node. Omit on create.
UUID of the root wrapper of the rule tree this node belongs to.
UUID of the immediate parent wrapper.
Right-hand side of a leaf comparison. Omitted on wrapper nodes.
Required event count and operator over a time period — used by event-frequency rules.
Hide child attributes
Hide child attributes
Time window for an event-frequency rule — rolling (relative) or fixed (absolute).
=, <, <=, >, >= Nested rule nodes — present on wrapper types.
Internal identifier of the persisted root rule, when present.
Cached size of the list. May lag a few seconds behind reality.
12584
Tags applied to the list. Used for organisation and filtering.
Time the dynamic list was last refreshed.
Was this page helpful?