/bff/emailer/template-add

Creates a new email template and optionally assigns it to an order group and status.

EmailerpostBffEmailerTemplate-add

Parameters

8 body

8 total

Body · 8

templateTypeCodestringRequired

Template type code (e.g. order-confirmation).

templateCodestringRequired

Unique code identifier for the template.

templateCodeVariantstring

Optional variant suffix for the template code.

namestringRequired

Human-readable template name.

subjectstringRequired

Default email subject line.

localestringRequired

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

en-GB vs. en-US (British vs. American spelling)
pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35

groupCodestring

Order group code to auto-assign the template to.

statusCodestring

Order status code to auto-assign the template to.

Request

POST /bff/emailer/template-add

post

curl -X POST "https://api.bizkithub.com/bff/emailer/template-add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "templateTypeCode": "order-confirmation",
  "templateCode": "order-confirmed-v1",
  "templateCodeVariant": "example_templateCodeVariant",
  "name": "Order Confirmation",
  "subject": "Your order has been confirmed",
  "locale": "cs",
  "groupCode": "example_groupCode",
  "statusCode": "example_statusCode"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key