Skip to content
HALOWERK

Formatwerk

docx template fill

Joins the text of each paragraph (body, headers, footers, footnotes, endnotes) from its w:t pieces, finds {{path.to.value}} placeholders even when Word split them across differently formatted runs, writes the value into the first piece (keeping its formatting) and removes the rest; all other XML stays byte-identical. A table row whose placeholders start with an array key (e.g. {{items.name}}) is repeated once per array element; an empty array removes the row. Values are XML-escaped, newlines.

POST https://format.halowerk.com/v1/docx-template-fill

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
content_base64stringNoThe DOCX file as base64 (a data: prefix and whitespace are tolerated); at most 10 MB decoded.
urlstringNoPublic http(s) URL of the DOCX file (at most 10 MB). Private, local and reserved addresses are refused.
dataobjectYesValues for the placeholders; nested objects via dot paths, arrays repeat table rows.
missingstringNoWhat to do with placeholders without a value: keep them, remove them, or fail with 422.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "content_base64": {
      "type": "string",
      "minLength": 8,
      "maxLength": 13981016,
      "description": "The DOCX file as base64 (a data: prefix and whitespace are tolerated); at most 10 MB decoded."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Public http(s) URL of the DOCX file (at most 10 MB). Private, local and reserved addresses are refused."
    },
    "data": {
      "type": "object",
      "description": "Values for the placeholders; nested objects via dot paths, arrays repeat table rows."
    },
    "missing": {
      "type": "string",
      "enum": [
        "keep",
        "empty",
        "error"
      ],
      "default": "keep",
      "description": "What to do with placeholders without a value: keep them, remove them, or fail with 422."
    }
  }
}

Open original schema

Published input example

{
  "data": {
    "customer": {
      "name": "Warehouse purchasing department"
    },
    "items": [
      {
        "name": "Storage crate",
        "qty": 2
      }
    ]
  },
  "content_base64": "UEsDBBQAAAAIAAAAYl0Al+qM1AAAAPkBAAATAAAAW0NvbnRlbnRfVHlwZXNdLnhtbK2Ru24CMRBFf2XlFrGDUlAgliZJm1DkB0be2V0rtsfyDIT8fWxeBYKkSWnfcx/SrD++E0lzCD5KZybVtAIQO1FAaTlRLMrAOaCWZx4hof3EkeBpsViC5agUda41w2zWLzTgzmvzeijf4jh2JpMX0zyfwNrVGUzJO4tadNjH/qZlfm5oi/PIyOSSzApg4G5DVR4XnH3ve8rZ9dRsMesbhkLBF+ceera7UJzt7zF3dvIwOEtXf01LmS2JuDgG316VgC7O/tphOVRY/n/HJfkyAY4X3/wAUEsDBBQAAAAIAAAAYl1hey9DiQAAAPIAAAALAAAAX3JlbHMvLnJlbHONzzsOAiEQBuCrEA6ws1pYGKCy2dZ4AQLDIy6PDBj19lJYrMbCcuaffH9GnHHVPZbcQqyNPdKam+Sh93oEaCZg0m0qFfNIXKGk+xjJQ9Xmqj3Cfp4PQFuDK7E12WIlp8XuOLs8K/5jF+eiwVMxt4S5/6j4uhiyJo9d8nshC/a9ngbLQQn4eFG9AFBLAwQUAAAACAAAAGJdzoTJ+YMAAADrAAAAHAAAAHdvcmQvX3JlbHMvZG9jdW1lbnQueG1sLnJlbHONzz0KAjEQBeCrhBxgZ7GwkGwqG1vxAkOcbIKbHzIj6O2NlREsLIfH+x5jzrShxJI5xMrqkbbMiw4i9QDALlBCnkql3BNfWkLpZ1uhorvhSrCb5z200dDWjKY6XRftSkqUhbW6PCv94xfvo6Njcfd38ccMDCa2leSzMnVLgzXw9Zt9AVBLAwQUAAAACAAAAGJdLuq1gLcAAAAGAQAAEQAAAHdvcmQvY29tbWVudHMueG1sTY7NCsIwEIRfJeRek/YgGNpefAEPnryFZm0CzQ+b1ejbmxQRYfmYYWeHHYtaovcQKLOX30JWZeKWKCkh8mLB63yICULd3SN6TdXiKkpEkzAukLMLq9/EIOVReO0Cn8dfJSvKmYlLXoV+kI048csDF6vbFTOQNFILtoDRBBMf5HDs+r6Tw1WelJR1bntlasAGms8x3B16RhZYhieEzuh3rdvcE/DNigsmlsMoWrYRd6ad39f+dZ4/UEsDBBQAAAAIAAAAYl1ZviQVDQEAAOUBAAARAAAAd29yZC9kb2N1bWVudC54bWx1Uc1OwzAMfhWrZ9QUhDhUW09M4jht8AAm8dpoTVIcd6Ga9u60HYxNgoutJN+P/WWRShN078gLfLrWxzIts0akK5WKuiGHMQ8d+fFtF9ihjEeuVQpsOg6aYrS+dq16KIon5dD6rFqk8j2YYerdXNY8t60MLUEqD9gusxdCMzLvM1Ut1AUzF6m2EhhrAs0oBB99EBQb/ASUGc5n0sXim7fuWTcYiUs4HnUfJTji3KOj0ymH1xQgXivHO1i9beCxyIsi/19cBzfFs0Ff01aQZdzBmmVWTLNfvJ+ptQfiAZKVxnqIdCAPY077cU0wOMRbi1vdlTd/qP4gaEdMXtM15HbQSFrWfL4+h69+P7b6AlBLAQIUAxQAAAAIAAAAYl0Al+qM1AAAAPkBAAATAAAAAAAAAAAAAACAAQAAAABbQ29udGVudF9UeXBlc10ueG1sUEsBAhQDFAAAAAgAAABiXWF7L0OJAAAA8gAAAAsAAAAAAAAAAAAAAIABBQEAAF9yZWxzLy5yZWxzUEsBAhQDFAAAAAgAAABiXc6EyfmDAAAA6wAAABwAAAAAAAAAAAAAAIABtwEAAHdvcmQvX3JlbHMvZG9jdW1lbnQueG1sLnJlbHNQSwECFAMUAAAACAAAAGJdLuq1gLcAAAAGAQAAEQAAAAAAAAAAAAAAgAF0AgAAd29yZC9jb21tZW50cy54bWxQSwECFAMUAAAACAAAAGJdWb4kFQ0BAADlAQAAEQAAAAAAAAAAAAAAgAFaAwAAd29yZC9kb2N1bWVudC54bWxQSwUGAAAAAAUABQBCAQAAlgQAAAAA"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’