Template API

Validate a template payload

Validates a template payload without saving it or rendering a PDF. It checks required fields, Base64 content, payload size limits, the template engine, Handlebars syntax and evaluation, and supported PDF parameters. Handlebars placeholders without matching values in sampleData render as empty text and do not cause validation to fail. Use it before previewing or saving a draft.

post/v1/templates/validate

Request

  • Base URL: https://api.pdfbolt.com
  • URL: https://api.pdfbolt.com/v1/templates/validate
  • Auth: API key in header PERSONAL-ACCESS-TOKEN

Request body

templateEngine'HANDLEBARS' required

Template engine used to evaluate template content.

contentstring byte required

Base64-encoded complete UTF-8 HTML document with optional Handlebars placeholders.

sampleDataobject required

JSON object used to evaluate the template during validation and preview.

Response

Template payload passed validation.

Changes

No recorded changes to this operation across all 1 revision of this API.