Skip to content

Get an e-mail template's text

GET /program/emails/{type}/copy
Scopeprogram:read
Customer session tokenNot accepted: call from your server with an API key
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_get_email_template_copy

The text of one customer e-mail: each field in the shop’s primary language (is_default: true when it is Charm’s default line, which follows the shop’s tone) and the shop’s own lines in its other languages. Placeholders such as {{points}} are filled in when the e-mail is sent.

NameInTypeDescription
typepathstringThe template id from GET /program/emails.

Returns EmailTemplateCopy.

FieldTypeDescription
revisioninteger
typestring
namestring
primary_languagestring or nullThe language of copy. (nullable)
languagesarray of stringThe shop’s languages, the primary one included.
fieldsarray of stringThe fields this template has.
copyobject
translationsobjectThe shop’s own lines in its other languages; a field missing here sends Charm’s default.
{
"revision": 1,
"type": "earn",
"name": "Gold",
"primary_language": "primary language",
"languages": [
"languages"
],
"fields": [
"fields"
],
"copy": {},
"translations": {}
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/program/emails/<type>/copy" \
-H "Authorization: Bearer chrm_live_..."

unauthorized · invalid_token · insufficient_scope · access_required · not_found · validation_error · rate_limited

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.