Skip to main content
Templates are pre-defined messages with text and optional media. They support merge tokens that auto-populate contact fields when sending, so you can personalize messages at scale without writing custom copy for every recipient.

The Template object

integer
Unique identifier for the template.
string
Display name of the template.
string
Client-provided unique identifier. Use this to map templates to records in your own system.
object
A GalleryContent object containing the message text and optional images. See the Content object section below.
integer
Identifier of the team that owns this template.
integer
Identifier of the user who created the template.
boolean
Whether the template is shared with all members of the team.
string
ISO 8601 timestamp when the template was created.
string
ISO 8601 timestamp when the template was last updated.
integer
Revision number. Increments on each update.
boolean
Whether the template has been archived.

The GalleryContent object

string
The message body. May contain merge tokens such as {{first_name}}.
Array of GalleryEntry objects representing images attached to the message.

Merge tokens

Merge tokens let you personalize template text using contact field values. When a message is sent, Heymarket replaces each token with the corresponding value from the recipient’s contact record.

Endpoints