Merge Tags

Merge tags are placeholders that get replaced with actual data when a message is sent. Use them in message templates, flows, and auto messages to personalize content. A merge tag is written in square brackets, like [ClientFirstName] or [EventDate].

Each merge tag is only included in the final message if the value exists. If a merge tag references a field that is empty or not available for that record, it is omitted rather than showing a blank or the raw tag.

When creating messages via the API, merge tag values can be provided inline in the request or pulled from existing data on the record.

Conditional Labels

If you put a label directly before a merge tag, the label will still appear even if the merge tag value is empty. For example:

Case Number: [CaseNumber]

If there is no case number, the message will show Case Number: with nothing after it, which looks incomplete.

To avoid this, wrap the label in % signs inside the merge tag brackets and put a space before the tag name: [%label% TagName]. The label and the value are treated as a unit, so if the value is empty, the entire tag (including the label) is omitted:

[%Case Number:% CaseNumber]

If the case number exists, the message shows Case Number: 12345. If the case number is empty, nothing is shown: no label, no blank space.

The space between the closing % and the tag name is required. The system inserts one space between the label and the value, so write the label exactly as you want it to read (for example, end it with a colon).

This is especially useful when a template includes multiple optional fields:

[ClientFirstName], here are your details:
[%Case Number:% CaseNumber]
[%Attorney:% AttorneyName]
[%Balance Due:% OutstandingBalance]

Only the lines where values exist will appear in the final message.

Requirements

Most merge tags only resolve when the related record is attached to the message. A record gets attached in one of two ways:

• Automatic attachment: When a record (event, payment, warrant, or sent file) triggers a message through a flow or auto message, that record is attached to the message automatically. The triggering record then appears as attached when you open the message.
• Manual attachment: When you compose a one-off message from a record screen, the message uses that record's data.

Requirements vary by record type:

Tag group	What must be attached for the tags to resolve
Agency, Date and Time, Schedule, Utility	Nothing. These resolve from your agency settings or the current date and time.
Client	A client must be attached.
Contact	A client must be attached. Contact tags also use the recipient address on the message.
Assigned User, Assigned Organization	The attached client must be assigned to that user or organization.
Event, Next Event	An event must be attached, or the attached client must have an upcoming event.
Payment	A payment must be attached. [TotalPayments] and [OutstandingBalance] need only a client.
Warrant	A warrant must be attached, or the attached client must have a warrant.
File	A sent file must be attached.
Check-In	A check-in must be attached.
Location, Judge	A location or judge must be linked to the attached event or payment.
Case, Attorney	A case must match the attached event or payment (see the Case section below).
Links and Portals	Opt-out and message links resolve on any sent message. Portal links require your agency portal to be configured.

If the required record is not attached, the related tags are removed from the message rather than left blank.

Available Merge Tags

Agency

Merge Tag	Description
[AgencyName]	Agency name.
[AgencyReference]	Agency reference identifier.
[AgencyPhone]	Agency phone number.
[AgencyEmail]	Agency email address.
[AgencyWebsite]	Agency website URL.
[AgencyAddress]	Agency street address.
[AgencyAddress2]	Agency address line 2.
[AgencyCity]	Agency city.
[AgencyState]	Agency state.
[AgencyZip]	Agency ZIP code.
[AgencyLogo]	Agency logo URL.

These tags resolve from your agency settings and do not require an attached record. Keep the values current in your agency settings so the tags always display correct information.

Assigned User

Merge Tag	Description
[AssignedUserName]	Name of the assigned user.
[AssignedUserPhone]	Assigned user's phone number.
[AssignedUserEmail]	Assigned user's email address.

These tags resolve only when the attached client is assigned to a user (staff member).

Assigned Organization

Merge Tag	Description
[AssignedOrganizationName]	Organization name.
[AssignedOrganizationPhone]	Organization phone number.
[AssignedOrganizationEmail]	Organization email address.
[AssignedOrganizationWebsite]	Organization website URL.
[AssignedOrganizationAddress]	Organization address.
[AssignedOrganizationVirtualLink]	Organization virtual meeting link.

These tags resolve only when the attached client is assigned to an organization.

Client

Merge Tag	Description
[ClientName]	Client display name.
[ClientFullName]	Client full name.
[ClientFirstName]	Client first name.
[ClientMiddleName]	Client middle name.
[ClientLastName]	Client last name.
[ClientInitials]	Client initials.
[ClientGroup]	Client group (e.g., defendant, victim).
[ClientReference]	Client external reference.
[ClientType]	Client type.
[ClientLanguage]	Client preferred language.
[ClientStatus]	Client status.
[ClientGender]	Client gender.
[ClientBirthDate]	Client date of birth.
[ClientBirthYear]	Client birth year.
[ClientAge]	Client age.

These tags require a client to be attached to the message.

Contact

Merge Tag	Description
[ContactName]	Contact name.
[ContactValue]	Contact value (phone number or email).
[ContactChannel]	Contact channel type.
[ContactType]	Contact type (e.g., mobile, home, work).

These tags require a client and contact to be attached to the message. [ContactName] falls back to the client name when no separate contact name is set.

Next Event

These tags resolve to the first upcoming event where the client is attached as the primary.

Merge Tag	Description
[NextEventDateTime]	Next event date and time.
[NextEventDate]	Next event date.
[NextEventTime]	Next event time.
[NextEventReference]	Next event reference.
[NextEventDescription]	Next event description.
[NextEventType]	Next event type.
[NextEventStatus]	Next event status.
[NextEventLocation]	Next event location.
[NextEventLocationName]	Next event location name.
[NextEventLocationFullAddress]	Next event location full address.
[NextEventCaseNumber]	Next event case number.
[NextEventLocationPhone]	Next event location phone.
[NextEventLocationWebsite]	Next event location website.
[NextEventLocationDescription]	Next event location description.
[NextEventAttorney]	Next event attorney.

Requirements for these tags to resolve:

1. Attach a client to the message.
2. The client must have at least one upcoming event that is not archived or trashed.
3. Link a specific event to the message if you want to override the first upcoming event.

Event

Merge Tag	Description
[EventDate]	Event date.
[EventTime]	Event time.
[EventDateTime]	Event date and time.
[EventDateDiff]	Time difference between now and the event date (e.g., "3 days").
[EventDateTimeDiff]	Time difference between now and the event date/time.
[EventReference]	Event reference.
[EventDescription]	Event description.
[EventStatus]	Event status.
[EventType]	Event type.
[EventURL]	Event URL.
[EventNotes]	Event notes.
[VirtualNotes]	Virtual event notes.
[EventsCount]	Number of upcoming events for the client (today or later, excluding archived).

Requirements for these tags to resolve:

1. Trigger the message from the event through a flow or auto message, or compose a one-off message from the event. This attaches the event automatically.
2. Open the message and confirm the event appears as attached.

If no event is attached, these tags are removed from the message.

Links and Portals

Merge Tag	Description
[OptoutURL]	Opt-out URL.
[PortalURL]	Portal URL.
[PortalOptout]	Portal opt-out link.
[MessageURL]	Message URL.
[FlowName]	Flow name.

[OptoutURL] and [MessageURL] use the message's own link and resolve on any sent message. [PortalURL] and [PortalOptout] require your agency portal to be configured. [FlowName] resolves only when the message is sent by a flow (or the attached event was sent by a flow).

Location

Merge Tag	Description
[Location]	Location.
[LocationName]	Location name.
[LocationFullAddress]	Full address.
[LocationAddress]	Street address.
[LocationAddress2]	Address line 2.
[LocationCity]	City.
[LocationCounty]	County.
[LocationState]	State.
[LocationZip]	ZIP code.
[LocationLink]	Location link.
[LocationInstructions]	Location instructions.
[LocationPasscode]	Location passcode.
[LocationNotes]	Location notes.
[LocationPhone]	Location phone number.
[LocationEmail]	Location email address.
[LocationWebsite]	Location website.
[LocationDescription]	Location description.
[LocationBusinessHours]	Location business hours.

These tags resolve from a location linked directly to the message, or from the location on the attached event or payment.

Judge

Merge Tag	Description
[JudgeName]	Judge name.
[JudgeReference]	Judge reference.
[JudgeType]	Judge type.
[JudgeDescription]	Judge description.
[JudgeAddress]	Judge address.
[JudgeFullAddress]	Judge full address.
[JudgeRoom]	Judge room number.
[JudgePhone]	Judge phone number.
[JudgeEmail]	Judge email address.
[JudgeWebsite]	Judge website.
[JudgeLink]	Judge link.
[JudgeVirtualLink]	Judge virtual meeting link.
[JudgeVirtualCode]	Judge virtual meeting code.
[PrimaryJudge]	Primary judge.
[RandomJudge]	Randomly selected judge.

These tags resolve from the judge assigned to the attached event. The event's judge name is matched against your saved judges to fill in the remaining judge details.

Case

Merge Tag	Description
[CaseNumber]	Case number.
[CaseStatus]	Case status.
[CaseCodes]	Case codes.
[CaseType]	Case type.
[CaseLocation]	Case location.
[CaseLocationAddress]	Case location address.
[CaseDescription]	Case description.
[CaseConditions]	Case conditions.
[CaseWarrantStatus]	Case warrant status.
[FileDate]	File date.
[OffenseDate]	Offense date.
[OffenseDescription]	Offense description.
[OffenseType]	Offense type.
[ArrestDate]	Arrest date.
[JudgmentDate]	Judgment date.
[ArrestTracking]	Arrest tracking number.
[ArrestingAgency]	Arresting agency.
[VictimName]	Victim name.
[OffenderName]	Offender name.
[NextCaseNumbers]	Case numbers from up to three of the client's cases.
[NextCaseDescriptions]	Case descriptions from up to three of the client's cases.
[NextCaseTypes]	Case types from up to three of the client's cases.
[NextCaseStatuses]	Case statuses from up to three of the client's cases.
[RelatedCaseNumbers]	Case numbers of the client's other events on the same date.

Requirements for these tags to resolve:

1. The case number is taken from the message, then from the attached payment, then from the attached event.
2. A matching case is looked up in your client cases. The case must not be archived or trashed.
3. When a client is attached, the case must belong to that client.
4. If no case matches and the attached event has a reference, [CaseNumber] falls back to that event reference.

If no case is found, the case tags are removed from the message.

The [NextCase...] tags are an exception: they list up to three of the attached client's cases and require only a client to be attached. [RelatedCaseNumbers] requires an attached event and lists the case numbers of the client's other events on the same date.

Attorney

Merge Tag	Description
[AttorneyName]	Attorney name.
[AttorneyFirmName]	Attorney firm name.
[AttorneyPhone]	Attorney phone number.
[AttorneyEmail]	Attorney email address.
[AttorneyBarNumber]	Attorney bar number.

These tags resolve when an attorney is assigned to the attached case.

Payment

Merge Tag	Description
[PaymentAmount]	Payment amount.
[PaymentDueDate]	Payment due date.
[PaymentIssueDate]	Payment issue date.
[PaymentNotes]	Payment notes.
[PaymentDescription]	Payment description.
[PaymentStatus]	Payment status.
[PaymentType]	Payment type.
[PaymentReference]	Payment reference.
[PaymentLink]	Payment link.
[PaymentCitation]	Payment citation.
[TotalPayments]	Total payments.
[OutstandingBalance]	Outstanding balance.

Requirements for these tags to resolve: Payments follow the same rules as events.

1. Trigger the message from the payment through a flow or auto message, or compose a one-off message from the payment.
2. Open the message and confirm the payment appears as attached.

If no payment is attached, these tags are removed from the message.

[TotalPayments] and [OutstandingBalance] are an exception: they are calculated across all of the client's payments and require only a client to be attached, not a specific payment.

Schedule

Merge Tag	Description
[UpcomingSchedules]	Upcoming schedules.
[CurrentSchedule]	Current schedule.
[CurrentSchedules]	Current schedules.

These tags resolve from your agency schedules and do not require an attached record.

Date and Time

Merge Tag	Description
[CurrentYear]	Current year.
[DateToday]	Today's date.
[DateTomorrow]	Tomorrow's date.
[DateYesterday]	Yesterday's date.
[Date12Hours]	Date 12 hours from now.
[DateNextWeek]	Date next week.
[DateNow]	Current date and time.
[TimeNow]	Current time.
[TimeZone]	Timezone abbreviation.
[TimeZoneLong]	Timezone full name.

These tags are based on when the message is created and do not require an attached record. For example, a message composed at 9:00 AM with a 5-minute delay resolves [TimeNow] to 9:00 AM (creation time), not 9:05 AM.

Utility

Merge Tag	Description
[RandomTag]	Random tag value.
[RandomNumbers]	Random numbers.
[BusinessHours]	Business hours.
[BusinessFromTime]	Business start time.
[BusinessToTime]	Business end time.
[BusinessDays]	Business days.
[NextBusinessDay]	Next business day.

These tags do not require an attached record. Business-hours tags resolve from your agency settings. To intentionally send a message that would otherwise be blocked as a duplicate (for example, when testing), add [RandomTag] to the template so each message has unique content.

Check-In

Merge Tag	Description
[CheckinLink]	Check-in link.
[CheckinURL]	Check-in URL.
[CheckinName]	Check-in name.
[CheckinPhone]	Check-in phone number.
[CheckinEmail]	Check-in email address.
[CheckinStatus]	Check-in status.
[CheckinService]	Check-in service.
[CheckinDepartment]	Check-in department.
[CheckinLocation]	Check-in location.
[CheckinLanguage]	Check-in language.
[CheckinNotes]	Check-in notes.
[CheckinVirtual]	Check-in virtual link.

These tags require a check-in to be attached to the message.

File

Merge Tag	Description
[FileName]	File name.
[FileDueDate]	File due date.
[FileExpireDate]	File expiration date.
[FileStatus]	File status.
[FileLink]	File link.

These tags require a sent file to be attached to the message, usually through a flow or auto message.

Warrant

Merge Tag	Description
[WarrantNumber]	Warrant number.
[WarrantType]	Warrant type.
[WarrantStatus]	Warrant status.
[WarrantCaseNumber]	Warrant case number.
[WarrantBondNumber]	Warrant bond number.
[WarrantIssueDate]	Warrant issue date.
[WarrantJudge]	Warrant judge.
[WarrantURL]	Warrant URL.

These tags resolve from a warrant attached to the message (usually through a flow or auto message) or from a warrant on the attached client.