Template

Create a new Office document by merging an office template with text, images, documents and tables.

The template provided needs to have been created based on the simple templating approach described in the article Create documents with Power Automate.

Note: While this article describes how to use Power Automate, the JSON tab which can be selected throughout the article makes it a great reference for developers.

Document Response Format

The document response format described the format you would like the File to be returned in.

Supported conversion types are:

• PDF - Adobe PDF.

• HTML - HTML Format, text and formatting only, images are not included.

• TXT - Text only, with very limited formatting and no images.

• Original - The same format as the template sent in the request. No conversion.

The following values should be provided in the Configuration object:

• PDF

• HTML

• TXT

• Original (default)

Required Properties

• Template

Its expected that one of Images, Rows, Text or Substitute Documents would also be included, since these are necessary to process the template.

Create a new document from a template

post

Create a new Office document by merging an office template with text, images, documents and tables.

Authorizations

API Key

X-API-KEYstringRequired

Body

application/json

textobjectOptional

Collection of document replacement tokens and associated replacement text.

Example: {"Title":"10docs","CompanyName":"10docs","CompanySlogan":"Delivering things","InvoiceNumber":"9999999","CompanyStreetAddress":"1 Documentation Road","CompanyCity":"Small Town","CompanyPostcode":"3455","CompanyWebsite":"www.10docs.com","InvoiceToName":"Joost van Hoorn","InvoiceToCompany":"VIP Customer Ltd","InvoiceToStreetAddress":"101 Client Office Road","Modified":"2023-10-24T14:48:26Z","Created":"2023-08-24T08:17:36Z"}

Responses

200

Success

403

The request is not authorized to make the template request

404

Service has not been found, please contact [email protected]

500

Something has gone wrong, please contact [email protected]

post

/documents/v1/template

HTTPcURLJavaScriptPython

POST /documents/v1/template HTTP/1.1
Host: api.tendocs.com/
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1436

{
  "template": {
    "file": {
      "$content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "$content": "iVBORw0KGgoAAAANSUhEUgA...[[Base64 Encoded File]]"
    }
  },
  "images": [
    {
      "token": "CompanyLogo",
      "file": {
        "$content-type": "image/png",
        "$content": "iVBORw0KGgoAAAANSUhE...[[Base64 Encoded File]]"
      }
    },
    {
      "token": "InvoiceToLogo",
      "file": {
        "$content-type": "image/png",
        "$content": "iVBORw0KGgoAAAANSUhEUgA...[[Base64 Encoded File]]"
      }
    }
  ],
  "text": {
    "Title": "10docs",
    "CompanyName": "10docs",
    "CompanySlogan": "Delivering things",
    "InvoiceNumber": "9999999",
    "CompanyStreetAddress": "1 Documentation Road",
    "CompanyCity": "Small Town",
    "CompanyPostcode": "3455",
    "CompanyWebsite": "www.10docs.com",
    "InvoiceToName": "Joost van Hoorn",
    "InvoiceToCompany": "VIP Customer Ltd",
    "InvoiceToStreetAddress": "101 Client Office Road",
    "Modified": "2023-10-24T14:48:26Z",
    "Created": "2023-08-24T08:17:36Z"
  },
  "substituteDocuments": [
    {
      "token": "TermsAndConditions",
      "file": {
        "$content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
        "$content": "UEsDBBQABgAIAAAAIQDbOn...[[Base64 Encoded File]]"
      }
    }
  ],
  "tables": [
    {
      "Token": "InvoiceLines",
      "Rows": [
        {
          "Title": "Line1",
          "Description": "Line Item 1",
          "Amount": 100
        },
        {
          "Title": "Line 2",
          "Description": "Line Item 2",
          "Amount": 200
        },
        {
          "Title": "Line 3",
          "Description": "Line Item 3",
          "Amount": 300
        }
      ]
    }
  ],
  "configuration": {
    "documentresponseformat": "PDF",
    "Keys": {
      "example_key1": "example_key_value1",
      "example_key2": "example_key_value2"
    }
  }
}

No content