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

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

​
Endpoints

MethodEndpointDescription
POST/v2/listsCreate a list
PUT/v2/lists/{id}Update a list
DELETE/v2/lists/{id}Delete a list