Execute Mail Merge online
Contents
[
Hide
]
Executes Mail Merge operation.
Execute Mail Merge online REST API
Server: https://api.aspose.cloud/v4.0
| Method | Endpoint |
|---|---|
| PUT | /words/MailMerge |
Request parameters:
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
Cleanup |
Query | string | Optional | The cleanup options. |
DocumentFileName |
Query | string | Optional | The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the “template” will be used instead. |
MergeWholeDocument |
Query | boolean | Optional | The flag indicating whether fields in whole document are updated while executing of a mail merge with regions. |
WithRegions |
Query | boolean | Optional | The flag indicating whether to execute Mail Merge operation with regions. |
Data |
Formdata | file | Required | File with mailmerge data. |
Template |
Formdata | file | Required | File with template. |
Options |
Formdata | FieldOptions | Optional | Field options. |
Note: Requires Client Id and Secret. See Quick Start to obtain credentials.
Response
| Field | Type | Description |
|---|---|---|
| Model | File | File with result of operation. |
Error reference
| Status | Code | Description | Resolution |
|---|---|---|---|
| 400 | bad_request |
Invalid parameter value or missing required field | Check the parameter format and ensure all required fields are provided |
| 401 | unauthorized |
Missing or invalid access token | Obtain a new access token via the authentication endpoint |
| 403 | forbidden |
Access to the requested resource is denied | Verify that the access token has the required permissions |
| 404 | not_found |
The requested resource does not exist | Check the resource ID or path for typos |
| 429 | rate_limited |
Too many requests — rate limit exceeded | Wait for the Retry-After period before making another request |
| 500 | internal_error |
An unexpected server error occurred | Retry the request after a short delay; contact support if the issue persists |
Usage examples
REST API
SDK
See Also
- Cloud SDKs — Create, Edit, Convert and Render Word documents via REST API.