Skip to Content

Update a template's metadata.

Changes the name, From, Reply-To, default language or variable declarations. Only fields that differ are written: a PATCH that changes nothing is a no-op. The version moves only when From, Reply-To or the default language changes, since those are what a send reads; a name or a declaration moves updatedAt alone.

openemail.templates.update(
  accountId: string,
  slug: string,
  body?: TemplatesUpdateBody,
  options?: CallOptions,
): ApiPromise<MailTemplate>

It calls PATCH /accounts/{accountId}/templates/{slug}: Update a template's metadata in the API reference.

Example

const mailTemplate = await openemail.templates.update(accountId, slug, {})

Arguments

ArgumentTypeDescription
accountIdstringAccount ULID identifier.. The path's {accountId}.
slugstringThe template's name within this account.. The path's {slug}.
bodyTemplatesUpdateBodyOptional. The request's body.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, MailTemplate. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400from_not_sendable or an invalid variable declaration
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404not_found
411length_required: Content-Length is required
413too_large: the JSON body exceeds 2 MiB
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

TemplatesUpdateBody

/** The body of `templates.update`. */
type TemplatesUpdateBody = {
  /** Language tag, e.g. `en` or `de-AT`. Stored lowercased. */
  defaultLang?: string
  from?: string
  name?: string
  replyTo?: string | null
  /** Documentation and dummy data per variable. Never a schema: a body may use what this omits. */
  variables?: Record<string, TemplatesUpdateBodyVariablesValue>
}

TemplatesUpdateBodyVariablesValue

/** The API's `TemplatesUpdateBodyVariablesValue`, as the document describes it. */
type TemplatesUpdateBodyVariablesValue = {
  description?: string
  /** Dummy data for the preview. A flag's sample is a boolean: the string "false" is truthy */
  sample?: string | number | boolean
}

It names these types of the API, each on a page of its own: MailTemplate.