Skip to main content
Lists organize multiple contacts for broadcast messaging. Each contact on a list receives the message individually and can reply privately. You can create and manage lists programmatically to keep your contact groups in sync with your own data sources.

​
The List object

​
integer
Unique identifier for the list.
​
string
Display name of the list.
​
string
Client-provided unique identifier. Use this to map Heymarket lists to records in your own system.
​
object
Object of ListTarget objects, keyed by phone number. Each value is an object with f (first name) and l (last name).
​
integer
Identifier of the team that owns this list.
​
integer
Identifier of the user who created the list.
​
boolean
Whether the list is shared with all members of the team.
​
string
ISO 8601 timestamp when the list was created.
​
string
ISO 8601 timestamp when the list was last updated.
​
integer
Revision number. Increments on each update.
​
boolean
Whether the list has been archived.
Use the v2 endpoints for new integrations. The v1 list pagination, count, and search endpoints are deprecated and will be removed in a future release.

​
Endpoints

​
Deprecated endpoints

There is no GET /v2/lists and no singular /v2/list path. Use the plural /v2/lists paths, and read lists through the paginate, count, and search sub-paths.