templates.setVariant
Write one language's copy.
Stores the subject and bodies for one language. A plain-text body is required; HTML is optional and builds a multipart/alternative message beside it.
openemail.templates.setVariant(
accountId: string,
slug: string,
lang: string,
body: TemplatesSetVariantBody,
options?: CallOptions,
): ApiPromise<TemplatesSetVariantResult>It calls PUT /accounts/{accountId}/templates/{slug}/variants/{lang}: Write one language's copy in the API reference.
Example
const result = await openemail.templates.setVariant(accountId, slug, lang, { subject: 'Hello', text: 'Hello from OpenEmail' })Arguments
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier.. The path's {accountId}. |
slug | string | The template's name within this account.. The path's {slug}. |
lang | string | Language tag, e.g. en or de-AT. Stored lowercased.. The path's {lang}. |
body | TemplatesSetVariantBody | 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, TemplatesSetVariantResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | template_invalid, text_required, subject_too_long or body_too_large |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | not_found |
409 | variant_limit_reached |
411 | length_required: Content-Length is required |
413 | too_large: the JSON body exceeds 2 MiB |
503 | temporary_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
TemplatesSetVariantBody
/** The body of `templates.setVariant`. */
type TemplatesSetVariantBody = {
html?: string | null
subject: string
text: string
}TemplatesSetVariantResult
/** What `templates.setVariant` answers. */
type TemplatesSetVariantResult = {
/** False when this language already held exactly this copy: nothing was written */
changed: boolean
lang: string
slug: string
stored: true
}