Save (upsert) a template override

Create or updates the company's content override for a template type. Region HTML arrives base64-encoded; null/empty regions inherit the system/white-label default. The endpoint validates variables in content against the type's allowed token set.

Auth: Both — authentication + an email-template feature check. company_id scoped by an ownership check; platform-owned types are forbidden (403) for non-platform companies. (Only the reachable companies differ per role.)

Rate limit: No rate limit.

Request

  • Body (region fields are base64-encoded HTML; ValidTemplateVariables checks tokens against the type):
FieldTypeRequiredNotes
company_idintegerYesMust be an existing account inside your own account tree.
typestringYesValid EmailTemplateType value.
headerstringNonullable, base64 HTML, max:80000, token-validated. Empty falls back to inherit default.
bodystringNonullable, base64 HTML, max:80000, token-validated.
footerstringNonullable, base64 HTML, max:80000, token-validated.
signaturestringNonullable, base64 HTML, max:80000, token-validated.
subject_overridestringNonullable, max:255, token-validated. Plain text (not base64).
template_modestringNonullable, one of regions, html.
custom_htmlstringNonullable, base64 HTML, max:400000. Used in html mode; omitting it on a regions-mode save does NOT clear a stored full-HTML draft.

Response{ data. } envelope. Unlike sibling endpoints there is no nested status/data object — the controller returns status + message directly inside the envelope.

  • data.status (string) — success.
  • data.message (string) — Email template saved successfully.

Errors: 403 when the template type is platform-managed or the email-template section is disabled for your account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
string
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json