Skip to main content
In the public API, “lists” are your segments. You can enumerate them and add/remove members on static lists. Dynamic segments compute their own membership and can’t be mutated. All endpoints use the X-Sender-Tenant + X-API-Key headers.

​
List all lists

​
limit
integer
default:"50"
Page size 1–100.
​
offset
integer
default:"0"
Records to skip.
Returns a paginated array of:
​
id
string
Segment UUID.
​
name
string
Segment name.
​
type
string
static or dynamic.
​
profiles
integer
Estimated member count.
The member count is the cached estimated size (fast), not a live recount. The tenant-facing Segments screen refreshes it.

​
Add members

​
emails
string[]
Up to 100 emails. Unknown emails create contacts.
​
contactIds
string[]
Up to 100 contact UUIDs.

​
Response

​
added
integer
Members added this call.
​
count
integer
Total members after the add.
Adding members fires the list.subscribed outbound webhook; removing fires list.unsubscribed.

​
Remove members

​
email
string
A single email.
​
emails
string[]
Up to 100 emails.
​
contactIds
string[]
Up to 100 contact UUIDs.
Returns { removed, count }.

​
Remove a single member by ID

Returns { count }.
Only static lists can be mutated. Attempting to add or remove on a dynamic segment returns 400.