Documentor Render a Word template

Parameters

Label	Type	Required	Description
Template URL	string	yes	Publicly accessible URL of the base Word document (.docx) to use.
Fragments	array_json	no	Ordered list of public .docx URLs to document fragments to replace the {{DocumentorFragments}} placeholder with. Items can either be a URL or an object with url and values fields, and optionally pictures (an array with objects with placeholder, url, and optionally width or height fields).
Values	JSON	no	JSON key-value mapping of the variable names and the values to replace them with.
Pictures	list	no	List of the placeholder names and the pictures to replace them with.
Output format	choice	yes	Format of the resulting document. Choices: .docx (Microsoft Word) .pdf (Portable Document Format)
Remove metadata	boolean	no	Whether to remove metadata, such as title and author name, from the resulting PDF document.

Placeholder values

The values field is an object mapping the placeholder names to the values to replace them with. Each value can either be:

• a string or number
• an array, which will be converted to a list
• an object, whose keys will be converted to level 3 headings with the values printed below

Pictures

The pictures field is an object mapping the placeholder names to the URLs to the images to replace them with.

Output

Example

Given this template and the following parameters, this document comes out.

Parameter	Value
Template URL	https://connectors.smartyellow.net/samples/documentor/dpa.docx
Values	{ "companyName": "Acme Ltd", "companyJurisdiction": "England and Wales", "companyAddress": "123 Business Road, London, UK", "processorName": "DataCloud Services GmbH", "processorJurisdiction": "Germany", "processorAddress": "Berliner Allee 50, 40212 Düsseldorf, Germany", "effectiveDate": "2025-05-14", "processingPurpose": "customer relationship management and marketing automation", "natureOfProcessing": "collection, storage, analysis, and deletion of personal data", "dataSubjects": "customers, prospects, and business contacts", "personalDataTypes": "names, email addresses, phone numbers, IP addresses", "securityMeasures": "encryption at rest and in transit, regular vulnerability assessments, access control", "subprocessorListURL": "https://datacloud.example.com/subprocessors", "governingLaw": "the laws of England and Wales", "jurisdiction": "the courts of London, UK", "controllerSignatoryName": "Jane Doe", "controllerSignatoryTitle": "Chief Privacy Officer", "controllerSignatoryDate": "2025-05-14", "processorSignatoryName": "Max Müller", "processorSignatoryTitle": "Head of Compliance", "processorSignatoryDate": "2025-05-14" }
Pictures	[ { "placeholder": "companyLogo", "url": "https://www.smartyellow.nl/logo.png", "height": 50 } ]
Output format	PDF
Remove metadata	no

The following JSON is returned.

Example output

{
  "ok": true,
  "outputURL": "https://connector-backend.smartyellow.net/artefacts/8f7f69af-a809-423d-bfae-2f2b78a5ec6c.png",
  "warnings": []
}

• outputURL contains the URL to the generated document. Read more on these URLs here.

• warnings may contain warnings about pictures you provided:

  • The format “$format” of the picture for “$placeholder” is unknown. Allowed are: jpg, png, gif, bmp.

  • Your provided dimensions for the “$placeholder” image result in an aspect ratio of 1:2.65, which does not match its intrinsic ratio of 1:3. This may result in a stretched image. You can resolve this by only setting a width or height instead of both.