v3
latestSwagger 2.02026-08-067506752.0 MBtemplate
Preview template content without saving it
post/v1/org/{orgId}/template/{templateId}/preview
Path parameters
orgIdstring required
Org identifier (either id or slug)
Query parameters
jobIdstring
Job id
scenarioIdstring
Scenario id to query
datestring date
Date
format'TEXT' | 'HTML' | 'PDF' required
Format
changeGroupingType'PRIMARY' | 'SCENARIO' | 'COMP_REVIEW'
Type of change grouping
changeGroupingIdstring
Change grouping id to query (null for primary)
useScenarioChangesboolean
Generate documents for only the changes that are in the scenario. This option also allows you to reference the change within the template, which is otherwise not allowed
Request body
Response
template previewed