Generate Documents - Deprecated Legacy Action
⚠️ Deprecation Notice: This action will be deprecated soon. Please use Generate Document Single for single document generation or Generate Documents Multiple for batch document generation.
PDF4me Generate Documents (legacy) action enables document generation from templates using Zapier automation. This action dynamically generates documents using Word or HTML templates with mustache syntax or merge fields as the source, with JSON or XML data sources.
Also, we have shared a zap to ease your setup.
Authenticating Your API Request
To access the PDF4me Web API, every request must include proper authentication credentials. Authentication ensures secure communication and validates your identity as an authorized user.
.png)
Parameters
Important: Parameters marked with an asterisk (***) are required and must be provided for the action to function correctly.
| Parameter | Type | Description | Example |
|---|---|---|---|
| Template File*** | File | A template file for generating documents. Supports Word or HTML templates | template.docx |
| Template File Name | String | Name for the output file. If not provided, will use template filename | generated_document |
| Template Type*** | Option | Template file type: Word - Set this value when sending a Word template HTML - Set this value when sending an HTML template | Word |
| Input Data*** | String | Text containing dynamic data values for merging with the template. JSON or XML format with document data | {"Documents":[{"name":"John"}]} |
| Input Data Type*** | Option | Data type for the template: JSON - Use JSON formatted data XML - Use XML formatted data | JSON |
| Output Document Type | Option | The output type of generated documents: PDF - Generate PDF Word - Generate Word Excel - Generate Excel HTML - Generate HTML | PDF |
| Meta Data | String | JSON string to specify fields that need formatting (e.g., Date fields with custom format) | {"FieldsMetaData":[...]} |
Output
The PDF4me Generate Documents action returns an array of generated documents for seamless Zapier workflow integration:
Note: The output is an array of documents. To process them one by one, you can use Looping by Zapier.
- Table
- JSON
- Schema
Table View
Response data in a structured table format:
| Parameter | Type | Description |
|---|---|---|
| File Name | String | The file name of the generated document without extension |
| File Extension | String | File extension of the output document |
| Full File Name | String | Complete filename including extension |
| File URL | String | Direct URL to access the generated document |
| File Size | Number | Size of the generated document in bytes |
JSON Response Format
The raw JSON response from the action:
[
{
"File Name": "document",
"File Extension": ".pdf",
"Full File Name": "document.pdf",
"File URL": "https://...",
"File Size": 125440
}
]
Schema View
The data structure and types of the response:
Array of documents
File Name: String - Document name
File Extension: String - File extension
Full File Name: String - Complete filename
File URL: String - Access URL
File Size: Number - Size in bytes
Migration Guide
Recommended Actions
For new workflows, please use:
- Generate Document Single - For generating one document at a time
- Generate Documents Multiple - For batch document generation
Migration Benefits
- Improved performance and reliability
- Better error handling and validation
- Enhanced workflow integration capabilities
- Simplified parameter configuration