Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I add tags to a tenancy agreement template in agentOS?

Open your tenancy agreement template in Microsoft Word, insert the relevant tags using double square bracket syntax (e.g. [[Tenant.Name]]), then upload the document to agentOS. Use a table to display multiple tenant names on a single page.

Tags are merge fields that pull information from agentOS into your document when it is generated. This guide walks through how to add tags to a tenancy agreement template, and how to handle a common issue that arises when a tenancy has multiple tenants.

Step 1: Create or open your template

Open Microsoft Word and either create a new A4 document or open an existing template you wish to edit.

Step 2: Add a tag

Type the tag you wish to use. For example, to pull through a tenant's name, type:

[[Tenant.Name]]

Save the file with a relevant name.

Step 3: Upload the document

Upload the document to agentOS. For guidance on uploading a new tenancy agreement or replacing an existing one, refer to the relevant articles in this knowledge base.

Step 4: Test the document

Find a property with multiple tenants linked to it. Go to the Tenants tab, click the Actions button along the relevant tenant row, and select Print Agreement. The document should generate.

Understanding the looping behaviour

If your template contains [[Tenant.Name]] as plain text (not inside a table), the document will generate one page per tenant. For example, if there are three tenants, three pages will be created — each showing one tenant's name.

To display all tenant names on a single page, you need to place the tag inside a table.

Using a table to list multiple tenants

  1. Remove the plain [[Tenant.Name]] tag from the document
  2. In Word, go to Insert > Table and insert a 1x1 table (one column, one row)
  3. Type [[Tenant.Name]] inside the table cell
  4. Right-click the table > Table Properties > Options
  5. Set all cell margins to 0 cm, then click OK twice
  6. To remove visible borders, select the table, go to the paragraph section in the Home ribbon and click the border icon > No Border
  7. Save the document and re-upload it to agentOS

When generated, the system will create a new row in the table for each tenant, displaying all names on a single page.

A full list of available tenancy agreement tags is available in the What tags can I use in a tenancy agreement template? article in this knowledge base.

Tenancy Agreement Letter

If you need any assistance, contact support@agentos.com.