How do I use custom fields in agentOS document templates?

Custom fields can be merged into your agentOS document templates using API ID tags. This works across three template types: System Letter Templates, Custom Document Templates, and Email Templates.

If you haven't set up custom fields yet, start there before using this guide.

Finding the API ID

Every custom field has a unique API ID. You'll need this to build your tag.

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. Find your field in the list — the API ID is shown 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*

*Rent Chase is hard-coded. To add custom fields to this document, contact support@agentos.com.

The tag must be entered as a single unbroken string.

Custom Document Templates

Custom document templates use a different tag format. The structure changes depending on the record type the field sits on.

Replace APIID with the API ID of your specific field.

Email Templates

Email tags follow a slightly different format.

Dropdown fields

If your custom field is a dropdown type, add .Value to the end of your tag:

[[CustomDataSystemF576216788707018896.Value]]

Need help? Contact support@agentos.com