Templates

Render a template publication

Renders one immutable publication against the data you pass, formatted in the locale and timeZone you name as a send formats them, and returns the subject, preheader, HTML and plain text a send would produce. data is validated against the publication's input schema exactly as a send validates it; invalid input returns a validation error that names each failing field. Nothing is sent or stored. Unpublished workspace edits are never rendered: only a publication id renders.

post/v1/templates/{id}/publications/{publicationId}/render

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/templates/{id}/publications/{publicationId}/render
  • Auth: API key in header x-api-key

Path parameters

idstring required
publicationIdstring required

Request body

dataobject required

The input to render with, validated against the publication's input schema.

localestring
timeZonestring

Response

TemplatePublicationRender

subjectstring required
preheaderstring
htmlstring required
textstring required

Changes

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