Get MailMerge Form Tag Expression

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

The FormTagExpression endpoint evaluates dynamic merge tags (template expressions) against specific records in Origami. {FormTags} are often used throughout Origami in document generation, form filling, data transformations, and custom reporting where you need to extract, format, or calculate values from a record.

Think of this as a "mail merge" system similar to Microsoft Word's merge fields, but accessible via API. You provide a template expression like Incident.Claimant-FirstName and get back the actual value from the specified record (e.g., "John").

The endpoint evaluates your tag expression and returns the processed result - either a simple value (string, number, date) or a complex calculated result. The response format is JSON containing the resolved value.

The tagExpression parameter accepts one tag expression at a time and returns the single evaluated result. If you need to evaluate multiple independent tags (like getting both first name and last name), you would need to make separate API calls:

However, that single expression can be quite flexible as it is capable of applying business logic.

So while you can only evaluate one expression per API call, that expression can internally reference multiple fields, perform calculations, or use fallback logic.

For an in-depth review, please see the following supplemental guide.

Query Params
string
required

The domain type of the subject record (Claim, Incident, Policy, etc).

integer
required

The primary key ID of the subject record.

string
required

This is the tag (or field) you wish to retrieve. Include object names as prefixes, even if retrieving from the primary object. For example, if I am resolving the LossDate for Claim ID 12345, then the full value I will pass should be Claim.LossDate.

Also note that in many other contexts throughout Origami, formTags are depicted using {curlyBrace} syntax. When providing a value to the API using the taxExpression input, do NOT use curlyBrace syntax.

Correct: Claim.Location.City
Incorrect: {Claim.Location.City}

Response
200
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!