Get an email template
Returns one template with its subject, body, if_empty setting, read-only attachments and engagement counters. A template saved before if_empty existed has none, and behaves as send. Counters are kept per template, so on a step with several weighted templates they compare the variants. They count events (three opens by one person count as 3) and are rebuilt every 15 minutes. Counts toward the Sequencer reads rate limit.
if_empty setting, files and engagement counters.
if_emptysays what happens when a variable is empty for a contact and has no fallback:waitholds the email for the rep,sendsends it with the gap. A template saved before the setting existed has none, and behaves assend.attachmentsare the files added to the template in the Salesfinity app. They are read-only through the API.
Example
Comparing A/B variants
Counters are kept per template, so when a step picks between several weighted templates, each template’ssend_count, open_count, click_count, reply_count, bounce_count and opt_out_count show how that
variant performed. They count events, not people (three opens by one person count as 3), and are rebuilt
every 15 minutes.Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
24-character template id.
Response
The template.
A reusable email: a subject and an HTML body, with variables.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
The team that owns the template (24-character id).
Author's team member id. Only the author can change or delete the template.
Template name.
Subject line, with variables. Only sent by email steps that start a thread. Empty on a template written for steps that reply in a thread.
HTML body, with variables.
What happens when a variable is empty for a contact and has no fallback: wait holds the email for the rep, send sends it with the gap. Absent on a template saved before the setting existed, which behaves as send.
send, wait Files sent with every email from this template, added in the Salesfinity app: as download links at the end of an email that starts a thread, and attached to a reply. Read-only: this API cannot add or remove them.
Whether the template is archived. Archiving only affects the archived filter on the list: steps that use it keep sending it, and it can still be attached to steps.
Emails sent from this template. Rebuilt every 15 minutes.
Number of opens on emails sent from this template, counted as events. Rebuilt every 15 minutes.
Number of replies on emails sent from this template, counted as events. Rebuilt every 15 minutes.
Number of bounces on emails sent from this template, counted as events. Rebuilt every 15 minutes.
Number of link clicks on emails sent from this template, counted as events. Rebuilt every 15 minutes.
Number of opt-outs on emails sent from this template. Rebuilt every 15 minutes.
When the template was created.
When it last changed.