JSON API - modifyMergeFields

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

modifyMergeFields

PREMIUM

TRIAL / ADVANCED

Modifies the values associated with Word template merge fields.

Note

You are reading the JSON API documentation. For the PHP API method please go to modifyMergeFields.

JSON data

{
    "variables": object,
    "options": {
        "target": "string"
    }
}

Key	Description
variables	Names of the merge fields as keys and their corresponding values.
target	Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "modifyMergeFields",
            "data": {
                "variables": {
                    "First Name": "John",
                    "Last Name": "Doe",
                    "Address 1": "My address"
                }
            }
        },
        {
            "action": "modifyMergeFields",
            "data": {
                "variables": {
                    "Header Info": "Data in header"
                },
                "options": {
                    "target": "header"
                }
            }
        },
        {
            "action": "modifyMergeFields",
            "data": {
                "variables": {
                    "Footer info": "Data in footer"
                },
                "options": {
                    "target": "footer"
                }
            }
        }
    ]
}

A template can be a local file, a Base64 string, or a remote file.

Release notes

phpdocx 18.0:
- new action.