Skip to main content
PATCH
Update an email template
Changes a template. Send only the fields you want to change; everything else keeps its value. Only the template’s author can change it. Anyone else gets 403, team admins included.

Example

When an edit takes effect

The template is read each time a step sends, so the next email from every step that uses it, in running sequences too, has the new text. Two things do not change:
  • Manual email tasks that already exist keep the draft they were created with.
  • Emails already sent.

Archiving

"archived": true only affects the archived filter on List email templates. Steps that use the template keep sending it, and it can still be attached to steps. To stop a template being sent, take it off its steps with Update a step. No field may be null. Sending the same body twice leaves the same result, so a retry is safe.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character template id.

Body

application/json
user_id
string
required

The team member making the change. Must be the template's author, and have an active plan or seat; anyone else, a team admin included, gets 403. A 24-character hexadecimal ID.

Example:

"507f1f77bcf86cd799439011"

name
string

Template name, 1 to 200 characters.

Maximum string length: 200
Example:

"Follow-up - logistics report"

subject
string

Subject line, up to 500 characters, with merge fields such as {{first_name}}. Only sent by an email step that starts a thread (the first email step, or one with new_thread: true). Leave it out, or send "", for a template used only by steps that reply in a thread.

Maximum string length: 500
Example:

"{{first_name}}, the Q3 logistics numbers"

body_html
string

HTML body, 1 to 100,000 characters. Merge fields, case-insensitive, filled from the contact when the step runs: {{first_name}}, {{last_name}}, {{company}} (the contact's account), {{title}}, and {{custom.<label>}} for a custom field by label. A known field with no value renders empty; anything else in double braces, including a misspelled name, is sent exactly as written. Values are HTML-escaped.

Maximum string length: 100000
tags
string[]

Up to 20 labels, each up to 50 characters.

Maximum array length: 20
Maximum string length: 50
archived
boolean

Archiving only affects the archived filter on the list: steps that use the template keep sending it.

Response

The updated template.

A reusable email: subject and HTML body with merge fields.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

team
string

The team that owns the template (24-character id).

user
string

Author's team member id. Only the author can change or delete the template.

name
string

Template name.

subject
string

Subject line, with merge fields. Only sent by email steps that start a thread. Empty on a template written for steps that reply in a thread.

body_html
string

HTML body, with merge fields.

tags
string[]
archived
boolean

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.

send_count
integer

Emails sent from this template. Rebuilt every 15 minutes.

open_count
integer

Number of opens on emails sent from this template, counted as events. Rebuilt every 15 minutes.

reply_count
integer

Number of replies on emails sent from this template, counted as events. Rebuilt every 15 minutes.

bounce_count
integer

Number of bounces on emails sent from this template, counted as events. Rebuilt every 15 minutes.

click_count
integer

Number of link clicks on emails sent from this template, counted as events. Rebuilt every 15 minutes.

opt_out_count
integer

Number of opt-outs on emails sent from this template. Rebuilt every 15 minutes.

created_at
string<date-time>

When the template was created.

updated_at
string<date-time>

When it last changed.