Render DocumentTemplate as PDF
Renders a document template with the provided data to PDF format.
The template receives the TemplateVariables data structure from the request.
All properties are optional and accessible via Liquid syntax (e.g., {{ PrimaryContact.FirstName }})
Example request:
POST /tenants/acme/document-templates/engagement-letter-standard/render
{
"designThemeCode": "professional-blue",
"data": {
"title": "Engagement Letter",
"client": {
"primaryContact": { "firstName": "John", "lastName": "Doe" },
"partner": { "name": "Jane Smith", "email": "jane@example.com" }
},
"practice": {
"address": "123 Main St",
"email": "info@practice.com",
"telephone": "555-1234"
}
}
}
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| code* | path string | |
Request Body*
{
"designThemeCode": "string",
"data": {
"title": "string",
"subtitle": "string",
"secondarySubtitle": "string",
"postalAddress": "string",
"addressee": "string"
}
}
Responses
200 OK
application/pdf
400 Bad Request
401 Unauthorized - Invalid or missing API key
404 Not Found