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

How do I use custom fields in agentOS document templates?

You can merge custom field data into your agentOS document templates — including system letter templates, custom document templates, and email templates — by inserting the custom field's API ID as a tag.

Once you have created custom fields on your agentOS records, you can display those field values within your documents and templates. This works across three template types: System Letter Templates, Custom Document Templates, and Email Templates.

If you have not yet set up your own document templates, guidance is available for System Letter Templates and Custom Document Templates. Alternatively, contact support@agentos.com for assistance.

Finding the API ID for a Custom Field

To include a custom field in a template, you first need to retrieve its API ID.

  1. Open any record that has the custom field applied.
  2. Click Customise Record on the right-hand side of the screen.
  3. Select Add Your Custom Fields.
  4. Locate the relevant field in the list — the API ID is displayed in the API ID column.

System Letter Templates

Custom fields can be merged into the following System Letter Templates:

  • Tenancy Agreements
  • Landlord Instructions
  • Rent Chase*

*The Rent Chase document is hard-coded. To include custom fields in this document, contact support@agentos.com.

Tag format for System Letter Templates:

Tag Example
[[CustomDataSystemAPIID]] [[CustomDataSystemF576216788707018896]]

The tag must be entered as a single unbroken string. It does not need to be placed inside a table.

Custom Document Templates

Custom fields can also be merged into your Custom Document Templates using a different tag format from the one used in System Letter Templates.

To find the correct tag format for Custom Document Templates, refer to the Custom Document Templates guide or contact support@agentos.com.

Email Templates

Custom field values can be merged into Email Templates using the same approach. Retrieve the API ID as described above and insert the appropriate tag into your email template body.

Note: If you need help locating your API IDs or setting up templates, contact support@agentos.com.