HighLevel: Update an email template

← Emails operations · Get started

Operation gohighlevel.update_email_template

Provider route: PATCH /emails/locations/{locationId}/templates/{templateId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["emails"]["updateEmailTemplate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.emails.updateEmailTemplate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.emails.update_email_template(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.locationId	string	Required within parent
path.templateId	string	Required within parent
body	Model	Required within parent	Expand Update an email template — request body — body

Referenced models: Update an email template — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update an email template — response body

Referenced models: Update an email template — response body

Schemas

Update an email template — response body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Required within parent	Whether template is archived
createdAt	string	Optional	Created timestamp
editorType	string	Optional	Template type Known values: html, text
fromEmail	string	Required within parent	Sender email address
fromName	string	Required within parent	Sender name
id	string	Required within parent	Template ID
isPlainText	boolean	Optional	Whether template is plain text
name	string	Required within parent	Template name
parentFolderId	string	Optional	Parent folder ID
previewText	string	Required within parent	Preview text
previewUrl	string	Required within parent	Preview URL
subjectLine	string	Required within parent	Email subject line
traceId	string	Optional	Trace ID of request
updatedAt	string	Optional	Last updated timestamp

Update an email template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	Whether template is archived
editorContent	string	Optional	Editor content to update. Required only when updating template content, and must be provided together with editorType. Provide HTML or plain-text string content.
editorType	string	Optional	Type of editor content. Required only when updating template content, and must be provided together with editorContent. One of: html, text
fromEmail	string	Optional	Sender email address
fromName	string	Optional	Sender name
name	string	Optional	Template name
parentFolderId	string	Optional	Parent folder ID. Pass `null` to move template to the root level.
previewText	string	Optional	Preview text
subjectLine	string	Optional	Email subject line
userId	string	Optional	ID of the user performing this action

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_email_template. Catalog operation: update-email-template. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["emails/templates.write"]

Pinned headers: {"Version": "v3"}

Official provider source