GuidesAPIChangelogStatus
Sign InSign Up

Edit a template

Suggest Edits

Discover how to alter your templates to fit ever-changing document needs

Learn how to make changes to existing templates, add new variables, remove old ones, change your formatting, add or remove supporting text and paragraphs, and more – all in this topic.

At the end of this guide, you should have updated your template to your liking.

Prerequisites:

  • You know what templates are
  • You have an existing template in your Inkit environment that you could edit
  • You are aware of your template needs (and know which changes you'd like to make)

Read more about:

Before you update your template

As you know, through templates, you can simplify your create requests. You include the correct key-value pairs, and Inkit Render populates your template as specified.

However, because you don't want any of your technical processes to break, it's essential to check a few things before you continue.

Check which API keys are currently utilizing the template you'd like to edit. For example, you may want to do a quick search in your codebase. Or ask your technical staff for assistance if you don't know how to.

After you've made sure you can edit the template, continue to the next section.

Edit a template

To edit templates, you do not need any special permissions. First, make sure you have an existing template available to change.

If you'd like to know how to create a template, please refer to this topic:

Currently, editing templates is done within the Inkit Render web environment. So, sign in to a user account and follow the next few steps:

  1. Sign in to the web environment here: https://app.inkit.com
  2. Navigate to the "Templates" tab on the sidebar
2217
  1. Find the template you want to edit and click on the "Edit" button. The process of editing templates varies and depends on the template type you're trying to edit.

Editing PDF templates

You can edit your PDF template just as you created it. Follow these instructions to get to the template editor:

  1. Click on the three dots on the right-hand side of your template
  2. Press edit
  3. Change your template as you see fit and save your changes
2224

You can also choose to replace your PDF template instead of editing it.

Editing DOCX templates

DocX templates cannot be edited in the web environment. You can simply edit them in Word and upload a new version.

You do this by:

  1. Pressing edit on the docx template you wish to upload a new version of
2224
  1. Uploading a new version and saving it.
2224

Editing HTML templates

2224

  1. Change text, add new variables (Using the {{variable}} formatting), or remove existing variables

  2. Confirm your changes by pressing "Save Changes"

2224
  1. (Optional) test your template

If all went well, you should have successfully edited your template. Optionally, you may choose to test your template. You can do so by generating a document from it.

If you'd like to learn more about generating documents from a template, then refer to this topic:

Updated 9 months ago