Skip to main content

templateRenderToHTML

Preview template output as HTML with provided data.

Renders the template using the provided payload data and returns HTML output for template testing, debugging, and preview purposes.

Possible errors:

  • TEMPLATE_NOT_FOUND: Template with specified ID does not exist
  • HANDLEBARS_RENDER_ERROR: Template rendering failed due to syntax or data issues
  • HANDLEBARS_PRECOMPILE_ERROR: Precompiled template rendering failed
  • HANDLEBARS_RENDER_VARIABLES_ERROR: Query variables rendering failed
  • TEMPLATE_DO_CUSTOM_QUERY_ERROR: Custom query execution failedAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]
templateRenderToHTML(
  id: String!
  input: TemplateRenderInput!
): String!

Arguments​

templateRenderToHTML.id ● String! non-null scalar​

Unique identifier for the template to render.

UUID that uniquely identifies the template in the system, used for retrieving the template content for HTML rendering.

templateRenderToHTML.input ● TemplateRenderInput! non-null input​

Template rendering data payload.

Contains the dynamic data that will be merged with the template content to generate the final HTML output with personalized content.

Type​

String scalar​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.