DocsAPI ReferenceEmailer/bff/emailer/template-validate
postEmailerAdmin BFF

/bff/emailer/template-validate

Statically analyses an email template and returns a list of structural errors and unknown-variable warnings.

EmailerpostBffEmailerTemplate-validate

Parameters

2 body

2 total
Body · 2
templatestringRequired

Template content (HTML or plain text) to validate.

templateCodestringRequired

Template type code used to resolve the list of allowed variables.

Request

POST /bff/emailer/template-validate

post
curl -X POST "https://api.bizkithub.com/bff/emailer/template-validate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "template": "example_template",
  "templateCode": "order-status-notification"
}'

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