Skip to content

List e-mail templates

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

Every customer e-mail with its switch, whether it actually sends (the shop’s global e-mail switch must be on too), and whether the API may switch it.

Returns EmailTemplateList.

FieldTypeDescription
revisioninteger
emails_enabledbooleanThe shop’s global e-mail switch, changed in the admin only.
dataarray of EmailTemplate
{
"revision": 1,
"emails_enabled": false,
"data": [
{
"type": "earn",
"name": "Gold",
"description": "Points for order #1042",
"sends_when": "sends when",
"enabled": true,
"sends": false,
"toggleable": false
}
]
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/program/emails" \
-H "Authorization: Bearer chrm_live_..."

unauthorized · invalid_token · insufficient_scope · access_required · 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.