Skip to main content
POST
Customize a system email

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Path Parameters

key
string
required

A system email key from GET /v1/platform/templates/system

Body

application/json
name
string

Name for the copy. Defaults to the system email's name.

Maximum string length: 255

Response

The organization's copy, as a template

A reusable message template.

id
integer
name
string
type
enum<string>

receipt is a legacy type: listed where it exists, never created.

Available options:
message,
transactional,
receipt
subject
string | null
previewText
string | null
content
object

A template body: html, blocks, or both.

contentType
enum<string>
Available options:
html,
text
systemTemplateKey
string | null

Set on the organization's own copy of a system email: the key of the email it replaces, which is then sent as this template.

translatedLocales
string[]

Locales with their own copy of this template. Per-locale copy is managed in the admin portal.

createdAt
string<date-time>
updatedAt
string<date-time>