Purpose: This article lists the fields available to merge fields in Communication Templates, for each object a template can reference. Use it together with Template Merge Fields, which explains how merge fields work and how to insert them with the picker.
This reference is generated from Administrate’s data model, so it includes both the fields shown in the merge field picker and the additional fields that can be typed by hand. Field names can change as the product evolves; a template is checked against the current fields every time you save it.
How to read the tables
- Field is the exact name to use in a placeholder, for example
{{ delegate.contact_name }}. Names are case sensitive. - Type tells you what the field produces. Record ID fields hold internal numeric identifiers, useful mainly for building links or cross-references. Related record rows are records you can chain into with a dot, for example
{{ event.location.name }}. List rows hold multiple records and only work inside loops, so insert those through the picker’s prepared blocks where possible. - In the picker? shows whether the merge field picker offers the field directly. Fields marked No still work when typed by hand: they pass the same save-time check, and a typo blocks the save with an Invalid merge field error, so you cannot break a sent message with a wrong name.
Note
A field that exists can still be empty for a given recipient, and an empty field renders as a blank in the message. Test templates with realistic data, especially when using hand-typed fields.
Custom fields
Custom fields defined on your instance are also available wherever the template can reach a record of a type that supports them: Learners, Events and Sessions, Accounts, Contacts, Course Templates, Achievements, Learning Paths, Learning Path learners, and Bookings (where they are labeled Attributes). They use a bracketed form whose key is the field’s Unique API Name where one is set, otherwise an internal key (the picker inserts the right key for you):
{{ event.custom["<field key>"] }}
{{ opportunity.custom["<field key>"] }}Because custom fields are defined per instance, they are not listed in the tables below; the picker always shows the ones available to your template.
Template objects
Learner registration (delegate)
Available as delegate in templates for the Students and Learner Booking Contacts audiences.
| Field | Type | In the picker? |
|---|---|---|
cancelled_at |
Date and time | Yes |
cancelled_by |
Record ID | Yes |
cc_addresses |
Text | Yes |
certificate_sent_on |
Date | Yes |
comms_contact_id |
Record ID | Yes |
contact_id |
Record ID | Yes |
created_at |
Date and time | Yes |
delegates_num |
Number | Yes |
event_id |
Record ID | Yes |
id |
Record ID | Yes |
is_provisional |
Yes / no | Yes |
last_modified_timestamp |
Date and time | Yes |
no_comms |
Yes / no | Yes |
notes |
Text | Yes |
original_entry_id |
Record ID | Yes |
original_registered_at |
Date and time | Yes |
parent_track_id |
Record ID | Yes |
passed |
Yes / no | Yes |
pricing_agreement_price_id |
Record ID | Yes |
promo_code_discount_amount |
Number | Yes |
promo_code_discount_description |
Text | Yes |
promo_code_discount_id |
Record ID | Yes |
registration_id |
Record ID | Yes |
source_type |
Choice | Yes |
tracking_identifier |
Text | Yes |
transfer_date |
Date and time | Yes |
transferred_by_id |
Record ID | Yes |
transferred_from |
Record ID | Yes |
transferred_to |
Record ID | Yes |
achievement |
Value | Yes |
booking_contact_email |
Value | No |
booking_contact_mobile_phone_number |
Value | No |
booking_contact_name |
Value | No |
contact_account_name |
Value | No |
contact_mobile_phone_number |
Value | No |
contact_name |
Value | No |
contact_primary_account_name |
Value | No |
custom_field_lookup_id |
Value | No |
email |
Value | No |
encoded_id |
Value | Yes |
event_end_date |
Value | No |
event_end_tz |
Value | No |
event_location_name |
Value | No |
event_start_date |
Value | No |
event_start_tz |
Value | No |
event_title |
Value | No |
expired |
Value | No |
expires_at |
Value | Yes |
filter_scores_before |
Value | Yes |
has_event_ended |
Value | No |
has_paid |
Yes / no | No |
has_parent_learning_path |
Value | No |
have_tokens_been_redeemed |
Value | No |
is_active |
Value | No |
is_cancelled |
Value | No |
is_deleted |
Value | No |
is_subbooking |
Value | No |
is_unnamed |
Value | No |
last_modified_tz |
Value | No |
lifecycle_state |
Value | No |
lms_access_expires_at |
Value | No |
lms_completed_date |
Value | No |
lms_is_complete |
Value | No |
lms_last_accessed |
Value | No |
mobile_phone_number |
Value | No |
overall_attendance |
Value | No |
paid_gross_amount |
Value | No |
pass_access_expired |
Value | No |
pass_access_expires_at |
Value | No |
price |
Value | Yes |
registration_invoice_paid |
Value | No |
result |
Value | No |
sessions_attended |
Number | No |
sessions_missed |
Number | No |
sessions_recorded |
Value | No |
status |
Value | No |
token_transaction_identifier |
Value | No |
total_gross_amount |
Value | No |
transfer_date_tz |
Value | No |
union_id |
Text | No |
attended |
Value | No |
brand_id |
Value | No |
brand_name |
Value | No |
cancelled_at_tz |
Value | Yes |
created_at_tz |
Value | Yes |
custom |
Custom fields, use custom["Field Name"] |
No |
expires_at_tz |
Value | No |
expires_in_days |
Value | No |
filter_scores_before_tz |
Value | No |
financial_description |
Text | No |
is_first_portal_login |
Number | Yes |
is_invoiced |
Value | No |
is_lms_setup |
Yes / no | No |
last_modified_timestamp_tz |
Value | Yes |
lms_progress |
Number | Yes |
lms_setup_link |
Value | Yes |
lms_setup_url |
Value | Yes |
lms_username |
Value | Yes |
price_currency_id |
Value | No |
score |
Value | No |
session_attendance |
Value | No |
tax_type |
Value | No |
tax_type_id |
Value | No |
achievements |
List of Achievement records (loops only) | Yes |
all_parent_learning_paths |
List of LearningPath records (loops only) | Yes |
attendance |
Related record: DelegateAttendance | Yes |
children |
List of Delegate records (loops only) | Yes |
comms_contact |
Related record: Contact | Yes |
contact |
Related record: Contact | Yes |
event |
Related record: Event | Yes |
global_custom_instance |
Related record: CustomInstance | No |
nominal_transaction |
Related record: NominalTransaction | No |
outcomes |
List of LearningOutcome records (loops only) | Yes |
parent |
Related record: Delegate | No |
price_level |
Related record: PriceLevel | No |
registration |
Related record: Registration | Yes |
template |
Related record: CustomTemplate | No |
template_instance |
Related record: CustomInstance | No |
token_order_receipt |
Related record: TokenOrderReceipt | Yes |
token_transaction |
Related record: TokenTransaction | Yes |
Achievement (achievement)
Available as achievement in templates for the Students and Learner Booking Contacts audiences.
| Field | Type | In the picker? |
|---|---|---|
achievement_type_id |
Record ID | Yes |
brand_id |
Record ID | Yes |
contact_id |
Record ID | Yes |
created_at |
Date and time | Yes |
custom_instance_id |
Record ID | Yes |
event_learner_id |
Record ID | Yes |
expires_at |
Date | Yes |
external_identifier |
Text | Yes |
id |
Record ID | Yes |
identifier |
Text | Yes |
is_deleted |
Yes / no | Yes |
issued_certificate_id |
Record ID | Yes |
learning_path_learner_id |
Record ID | Yes |
revoked_at |
Date | Yes |
uniqueness_checksum |
Text | Yes |
valid_from |
Date | Yes |
achievement_type_name |
Value | No |
custom_field_lookup_id |
Value | No |
document_url |
Value | Yes |
exposed_identifier |
Value | No |
lifecycle_state |
Value | No |
registerable_id |
Value | No |
sequence_id |
Value | No |
custom |
Custom fields, use custom["Field Name"] |
No |
achievement_certificate_documents |
List of AchievementCertificateDocument records (loops only) | Yes |
achievement_type |
Related record: AchievementType | Yes |
contact |
Related record: Contact | Yes |
delegate |
Related record: Delegate | Yes |
global_custom_instance |
Related record: CustomInstance | Yes |
learning_assignment |
Related record: LearningAssignment | Yes |
Contact (contact)
Available as contact in templates for the Contact audience. Also reachable from other records, for example delegate.contact.
| Field | Type | In the picker? |
|---|---|---|
account_id |
Record ID | Yes |
address_country_id |
Record ID | Yes |
address_locality |
Text | Yes |
address_postcode |
Text | Yes |
address_region |
Text | Yes |
address_street |
Text | Yes |
address_town |
Text | Yes |
address_unit |
Text | Yes |
biography |
Text | Yes |
created_on |
Date and time | Yes |
custom_check_1 |
Yes / no | Yes |
custom_check_2 |
Yes / no | Yes |
custom_check_3 |
Yes / no | Yes |
custom_check_4 |
Yes / no | Yes |
custom_date_1 |
Date | Yes |
custom_date_2 |
Date | Yes |
custom_dropdown_1 |
Number | Yes |
custom_dropdown_2 |
Number | Yes |
custom_instance_id |
Record ID | Yes |
custom_instructor_check_1 |
Yes / no | Yes |
custom_instructor_text_1 |
Text | Yes |
custom_instructor_text_2 |
Text | Yes |
custom_instructor_text_3 |
Text | Yes |
custom_instructor_text_4 |
Text | Yes |
custom_instructor_text_5 |
Text | Yes |
custom_instructor_text_6 |
Text | Yes |
custom_instructor_text_7 |
Text | Yes |
custom_membership_number |
Text | Yes |
custom_text_1 |
Text | Yes |
custom_text_2 |
Text | Yes |
custom_text_3 |
Text | Yes |
custom_unsubscribe_from_third_party_mail |
Yes / no | Yes |
department |
Text | Yes |
dormant |
Yes / no | Yes |
email2 |
Text | Yes |
email3 |
Text | Yes |
fax |
Text | Yes |
first_name |
Text | Yes |
home_telephone |
Text | Yes |
id |
Record ID | Yes |
inactive |
Yes / no | Yes |
instructor_company_id |
Record ID | Yes |
instructor_contract_notes |
Text | Yes |
instructor_owner_id |
Record ID | Yes |
integration_external_id |
Record ID | Yes |
is_staff |
Yes / no | Yes |
job_title |
Text | Yes |
last_name |
Text | Yes |
legacy_external_id |
Record ID | Yes |
linkedin |
Text | Yes |
locale |
Text | Yes |
marketing_activity_id |
Record ID | Yes |
membership_organization |
Text | Yes |
middle_name |
Text | Yes |
mobile |
Text | Yes |
notes |
Text | Yes |
preferred_locale_id |
Record ID | Yes |
profile_picture_document_id |
Record ID | Yes |
province_code |
Text | Yes |
skype |
Text | Yes |
source_details |
Text | Yes |
source_type_id |
Record ID | Yes |
tel |
Text | Yes |
timezone |
Text | Yes |
unsubscribe_from_communications |
Yes / no | Yes |
working_pattern_rotation_id |
Record ID | Yes |
is_coordinator |
Yes / no | Yes |
account_name |
Value | No |
can_staff_event |
Value | No |
company_id |
Value | No |
company_name |
Value | No |
custom_field_lookup_id |
Value | No |
dont_mail |
Value | No |
email |
Value | Yes |
email_address |
Value | No |
email_primary |
Value | No |
encoded_id |
Value | Yes |
full_name |
Value | No |
honorific_id |
Value | No |
is_admin |
Value | No |
is_administrator |
Value | No |
is_deleted |
Value | No |
is_instructor |
Value | No |
is_tutor |
Value | No |
membership_number |
Value | No |
name |
Value | Yes |
no_third_party |
Value | No |
salutation |
Value | No |
search_index |
Text | No |
updated_at |
Value | No |
calendar_setup_url |
Value | Yes |
custom |
Custom fields, use custom["Field Name"] |
No |
is_active_instructor |
Value | No |
skype_name |
Value | No |
user_id |
Value | Yes |
account |
Related record: Account | Yes |
accounts |
List of Account records (loops only) | Yes |
address_country |
Related record: Country | Yes |
courses |
List of Course template records (loops only) | Yes |
credentials |
List of ContactCredential records (loops only) | Yes |
delegates |
List of Delegate records (loops only) | Yes |
enquiries |
List of Enquiry records (loops only) | Yes |
inbound_emails |
List of InboundEmail records (loops only) | Yes |
instructor_company |
Related record: Company | Yes |
instructor_rates |
List of InstructorCourseRate records (loops only) | Yes |
qualifications |
List of Qualifications records (loops only) | Yes |
source_type |
Related record: SourceType | Yes |
staff_roles |
List of ContactStaffRole records (loops only) | Yes |
supervisor_mappings |
List of ContactSupervisorMapping records (loops only) | Yes |
user |
Related record: User | Yes |
Event (event)
Available as event in templates for the Contact and SurveyMonkey Respondents audiences. Also reachable from other records, for example delegate.event or staff.event.
| Field | Type | In the picker? |
|---|---|---|
achievement_type_id |
Record ID | Yes |
achievement_valid_from |
Choice | Yes |
actual_registrations |
Number | Yes |
allowed_missed_sessions |
Number | Yes |
auto_pass_learner |
Yes / no | Yes |
cancelled_at |
Date | Yes |
course_id |
Record ID | Yes |
created_at |
Date and time | Yes |
duplicated_from_id |
Record ID | Yes |
end_calculated |
Date and time | No |
end_date |
Date and time | Yes |
end_time |
Time | Yes |
end_utc_calculated |
Date and time | No |
expected_students |
Number | Yes |
finance_code |
Text | Yes |
id |
Record ID | Yes |
image_filename |
Text | Yes |
image_hash |
Text | Yes |
image_mimetype |
Text | Yes |
is_cancelled |
Yes / no | Yes |
is_deleted |
Yes / no | Yes |
is_eu_digital_good |
Yes / no | Yes |
is_online |
Yes / no | Yes |
is_provisional |
Yes / no | Yes |
lms_announcements |
Text | Yes |
lms_end_utc |
Date and time | Yes |
lms_expire_days |
Number | Yes |
lms_pass_mark |
Number | Yes |
lms_start_utc |
Date and time | Yes |
locale_id |
Record ID | Yes |
location_id |
Record ID | Yes |
max_places |
Number | Yes |
min_places |
Number | Yes |
notes |
Text | Yes |
notes2 |
Text | Yes |
parent_id |
Record ID | Yes |
persistent |
Yes / no | Yes |
purchase_requires_review |
Yes / no | Yes |
registration_deadline |
Date and time | Yes |
registration_opens_at |
Date and time | Yes |
remote_meeting_host_contact_id |
Record ID | Yes |
remote_meeting_host_staff_role_id |
Record ID | Yes |
remote_meeting_id |
Record ID | Yes |
remote_meeting_type |
Choice | Yes |
remote_meeting_url |
Text | Yes |
require_registration_invoice_to_be_paid |
Yes / no | Yes |
start_calculated |
Date and time | No |
start_date |
Date and time | Yes |
start_time |
Time | Yes |
start_utc_calculated |
Date and time | No |
tag_id |
Record ID | Yes |
target_fill_rate |
Number | Yes |
time_zone_name |
Text | Yes |
updated_at |
Date and time | Yes |
upload_tracking_document_id |
Record ID | Yes |
venue_id |
Record ID | Yes |
booking_account_id |
Value | No |
booking_account_name |
Value | No |
classroom_end |
Value | Yes |
classroom_end_tz |
Value | Yes |
classroom_start |
Value | Yes |
classroom_start_tz |
Value | Yes |
code |
Value | Yes |
code_comparator |
Value | No |
combined_end_fields |
Value | No |
combined_end_fields_tz |
Value | No |
combined_end_fields_utc |
Value | No |
combined_start_fields |
Value | No |
combined_start_fields_tz |
Value | No |
combined_start_fields_utc |
Value | No |
company_id |
Value | No |
company_locale |
Value | Yes |
course_code |
Value | No |
course_title |
Value | No |
created_at_tz |
Value | No |
currency |
Value | No |
custom_field_lookup_id |
Value | No |
default_price_amount |
Value | No |
default_price_currency |
Value | No |
default_price_level_id |
Value | No |
delegates_booked |
Value | No |
delegates_max |
Value | No |
delegates_min |
Value | No |
display_identifier |
Value | No |
disposition |
Value | No |
encoded_id |
Value | Yes |
end |
Value | Yes |
end_comparator |
Value | No |
end_date_comparator |
Value | No |
end_tz |
Value | Yes |
end_utc |
Value | No |
event_flags |
Value | No |
event_type |
Value | No |
fill_rate |
Value | Yes |
has_places_remaining |
Value | No |
is_active |
Value | No |
is_before_registration_deadline |
Value | No |
is_iht |
Value | No |
is_inactive |
Value | No |
is_registrable |
Value | No |
learning_mode |
Value | No |
lifecycle_state |
Text | No |
lms_enabled |
Value | Yes |
lms_end |
Value | Yes |
lms_end_or_cancelled_at |
Value | No |
lms_end_tz |
Value | Yes |
lms_start |
Value | Yes |
lms_start_tz |
Value | Yes |
location_name |
Value | Yes |
mapped_forecast_revenue |
Value | No |
max_session_end_time |
Value | No |
min_session_start_time |
Value | No |
needs_lms_migration |
Value | No |
personnel_booked |
Value | No |
places_available |
Value | No |
places_booked |
Value | No |
places_interested |
Value | No |
places_remaining |
Value | No |
places_reserved |
Value | No |
profit |
Value | No |
region |
Value | No |
region_code |
Value | No |
region_id |
Value | No |
register_by |
Value | No |
registration_deadline_utc |
Value | No |
search_index |
Text | No |
sold_out |
Value | No |
start |
Value | Yes |
start_comparator |
Value | No |
start_date_comparator |
Value | No |
start_tz |
Value | Yes |
start_utc |
Value | No |
status |
Value | No |
tax_type |
Value | No |
tax_type_id |
Value | No |
timezone |
Value | No |
title |
Value | Yes |
title_comparator |
Value | No |
total_costs |
Value | No |
total_revenue |
Value | No |
type |
Value | No |
tz_name |
Value | No |
union_id |
Text | No |
updated_at_tz |
Value | No |
active_students |
Value | No |
administrator |
Value | Yes |
administrator_id |
Value | No |
all_students |
Value | No |
custom |
Custom fields, use custom["Field Name"] |
No |
default_price_id |
Value | No |
description |
Text | No |
end_date_tz |
Value | Yes |
end_time_tz |
Value | No |
exclusive_registration_id |
Value | No |
financials |
Value | No |
has_external_feedback_provider |
Value | No |
iht_account |
Value | Yes |
iht_registration |
Value | No |
instructor |
Value | Yes |
instructor_id |
Value | No |
is_legacy |
Value | No |
lms_summary |
Text | No |
location |
Value | Yes |
location_address |
Value | Yes |
location_code |
Value | Yes |
location_description |
Value | No |
location_object |
Value | No |
location_status |
Value | Yes |
location_url |
Value | Yes |
registration_deadline_tz |
Value | Yes |
revenue_entries |
Value | No |
sessions_with_same_lifecycle_state |
Value | No |
start_date_tz |
Value | Yes |
start_time_tz |
Value | No |
student_stats |
Value | No |
tz |
Value | No |
unnamed_students |
Value | No |
achievement_type |
Related record: AchievementType | No |
attendance |
List of DelegateAttendance records (loops only) | Yes |
compound_children |
List of Event records (loops only) | Yes |
course |
Related record: Course template | Yes |
delegate_template |
Related record: CustomTemplate | No |
delegates |
List of Delegate records (loops only) | Yes |
deltas |
List of EventLog records (loops only) | Yes |
document_mappings |
List of DocumentMappingTable records (loops only) | Yes |
documents |
List of Document records (loops only) | Yes |
duplicated_from |
Related record: Event | Yes |
duplicated_parent |
List of Event records (loops only) | Yes |
emails |
List of OutboundEmail records (loops only) | Yes |
event_achievement_types |
List of EventAchievementType records (loops only) | Yes |
event_costs |
List of EventCost records (loops only) | Yes |
feedback_engine_collector |
List of FeedbackEngineCollector records (loops only) | Yes |
feedback_engine_survey_event_link |
List of FeedbackEngineSurveyEventLink records (loops only) | Yes |
global_custom_instance |
Related record: CustomInstance | No |
iht |
Related record: EventIHT | Yes |
lms_resources |
List of LmsResource records (loops only) | Yes |
locale |
Related record: Locale | Yes |
nominal_entries |
List of NominalEntry records (loops only) | Yes |
parent |
Related record: Event | Yes |
personnel |
List of EventPersonnel records (loops only) | Yes |
prices |
List of EventPrice records (loops only) | Yes |
printouts |
List of EventPrintout records (loops only) | Yes |
resource_bookings |
List of ResourceBooking records (loops only) | Yes |
sessions |
List of Event records (loops only) | Yes |
tag |
Related record: Tag | Yes |
tasks |
List of Task records (loops only) | Yes |
venue |
Related record: Venue | Yes |
Gift voucher (gift_voucher)
Available as gift_voucher in templates for the Gift Voucher Recipient audience.
| Field | Type | In the picker? |
|---|---|---|
activated_at |
Date and time | Yes |
code |
Text | Yes |
created_at |
Date and time | Yes |
currency_code |
Record ID | Yes |
deactivated_at |
Date and time | Yes |
email_configuration_id |
Record ID | Yes |
expires_at |
Date and time | Yes |
expiry_processed |
Yes / no | Yes |
id |
Record ID | Yes |
intended_balance |
Number | Yes |
message |
Text | Yes |
recipient_email_address |
Text | Yes |
recipient_name |
Text | Yes |
recipient_postal_address_country_id |
Record ID | Yes |
recipient_postal_address_line_one |
Text | Yes |
recipient_postal_address_line_two |
Text | Yes |
recipient_postal_address_postcode |
Text | Yes |
recipient_postal_address_town |
Text | Yes |
expires_at_comparator |
Value | No |
balance |
Value | Yes |
currency_symbol |
Value | Yes |
delivery_method |
Value | Yes |
initial_balance |
Value | No |
name |
Value | No |
total_credits_amount |
Value | No |
total_deactivated_amount |
Value | No |
total_debits_amount |
Value | No |
total_expiry_revenue |
Value | No |
Learning path learner (learning_assignment)
Available as learning_assignment in templates for the Learning Assignments audience.
| Field | Type | In the picker? |
|---|---|---|
account_id |
Record ID | Yes |
cancelled_at |
Date and time | Yes |
completed_at |
Date and time | Yes |
contact_id |
Record ID | Yes |
created_at |
Date and time | Yes |
custom_instance_id |
Record ID | Yes |
delegates_num |
Number | Yes |
id |
Record ID | Yes |
is_cancelled |
Yes / no | Yes |
is_completed |
Yes / no | Yes |
is_deleted |
Yes / no | Yes |
last_accessed |
Date and time | Yes |
notes |
Text | Yes |
parent_learner_id |
Record ID | Yes |
price |
Number | Yes |
price_level_id |
Record ID | Yes |
progress |
Number | Yes |
promo_code_discount_amount |
Number | Yes |
promo_code_discount_description |
Text | Yes |
promo_code_discount_id |
Record ID | Yes |
reason_assignment_rule_id |
Record ID | Yes |
registration_id |
Record ID | Yes |
started_at |
Date and time | Yes |
track_id |
Record ID | Yes |
tracking_identifier |
Text | Yes |
company_id |
Value | No |
contact_name_comparator |
Value | No |
custom_field_lookup_id |
Value | No |
expected_progress |
Value | No |
has_parent |
Value | No |
is_active |
Value | No |
learner_completed_objectives |
Number | No |
learner_total_objectives |
Number | No |
learning_path_name_comparator |
Value | No |
lifecycle_state |
Value | No |
lms_title |
Value | No |
most_recently_completed |
Value | No |
pass_access_expired |
Value | No |
progress_made |
Value | No |
union_id |
Text | No |
brand_id |
Value | No |
custom |
Custom fields, use custom["Field Name"] |
No |
is_first_portal_login |
Number | Yes |
is_invoiced |
Value | No |
lms_setup_link |
Value | Yes |
lms_setup_url |
Value | Yes |
lms_username |
Value | Yes |
tax_type |
Value | No |
tax_type_id |
Value | No |
account |
Related record: Account | Yes |
achievement |
Related record: Achievement | Yes |
contact |
Related record: Contact | Yes |
global_custom_instance |
Related record: CustomInstance | Yes |
nominal_transaction |
Related record: NominalTransaction | No |
outcomes |
List of LearningOutcome records (loops only) | Yes |
registration |
Related record: Registration | Yes |
track |
Related record: LearningTrack | Yes |
Booking (opportunity)
Available as opportunity in templates for the Booking Owner, Booking Contact, and Booking Recipient audiences. Bookings are called opportunities internally, so the variable name is opportunity.
| Field | Type | In the picker? |
|---|---|---|
account_id |
Record ID | Yes |
brand_id |
Record ID | Yes |
closed_at |
Date and time | Yes |
closing_date |
Date | Yes |
company_id |
Record ID | Yes |
contact_id |
Record ID | Yes |
created_at |
Date and time | Yes |
currency_id |
Record ID | Yes |
customer_reference |
Text | Yes |
discount_type_id |
Record ID | Yes |
external_id |
Record ID | Yes |
id |
Record ID | Yes |
invoice_id |
Record ID | Yes |
is_deleted |
Yes / no | Yes |
is_training_request |
Yes / no | Yes |
marketing_activity_id |
Record ID | Yes |
name |
Text | Yes |
parent_id |
Record ID | Yes |
portal_id |
Record ID | Yes |
promotion_type_id |
Record ID | Yes |
region_id |
Record ID | Yes |
registration_id |
Record ID | Yes |
secure_identifier |
Text | Yes |
source_type_id |
Record ID | Yes |
token_order_identifier |
Record ID | Yes |
token_type_identifier |
Record ID | Yes |
token_value |
Number | Yes |
updated_at |
Date and time | Yes |
user_id |
Record ID | Yes |
value |
Number | Yes |
account_name |
Value | No |
age |
Value | No |
billing_contact_name |
Value | No |
categories |
Value | No |
categories_order |
Text | No |
company_name |
Value | No |
created_at_tz |
Value | No |
days_to_win |
Value | No |
financial_unit_value |
Value | No |
interests_item_learning_category_names |
Value | No |
region_code |
Value | No |
region_name |
Value | No |
step_id |
Value | No |
updated_at_tz |
Value | No |
user_name |
Value | No |
win_probability |
Value | No |
attributes_by_mapping |
Value | No |
custom |
Custom fields, use custom["Field Name"] |
No |
discount_total |
Value | Yes |
gift_voucher_total |
Value | Yes |
grand_total |
Value | Yes |
graphql_id |
Value | Yes |
order_retrieval_url |
Value | Yes |
payable_total |
Value | Yes |
sub_total |
Value | Yes |
attributes |
Value | No |
account |
Related record: Account | Yes |
children |
List of Opportunity records (loops only) | Yes |
company |
Related record: Company | Yes |
contact |
Related record: Contact | Yes |
currency |
Related record: Currency | Yes |
deltas |
List of OpportunityUpdateLog records (loops only) | No |
discount_type |
Related record: DiscountType | Yes |
documents |
List of OpportunityDocument records (loops only) | No |
emails |
List of OutboundEmail records (loops only) | No |
enquiries |
List of Enquiry records (loops only) | No |
gift_voucher_applications |
List of GiftVoucherOpportunityApplication records (loops only) | Yes |
interests |
List of OpportunityInterest records (loops only) | Yes |
invoice |
Related record: SalesInvoice | Yes |
marketing_activity |
Related record: MarketingActivity | Yes |
parent |
Related record: Opportunity | Yes |
promotion_code_mappings |
List of OpportunityPromotionCode records (loops only) | Yes |
promotion_type |
Related record: PromotionType | Yes |
promotional_code_mappings |
List of OpportunityPromotionCode records (loops only) | Yes |
quotes |
List of OpportunityQuote records (loops only) | Yes |
region |
Related record: Region | Yes |
registration |
Related record: Registration | Yes |
resources |
List of OpportunityResource records (loops only) | Yes |
source_type |
Related record: SourceType | Yes |
statistics |
List of OpportunityStatistic records (loops only) | No |
step |
Related record: OpportunityStep | Yes |
token_type |
Related record: TokenType | No |
trigger_logs |
List of OpportunityTriggerLog records (loops only) | No |
user |
Related record: User | Yes |
values |
List of OpportunityValue records (loops only) | Yes |
Payment (payment)
Available as payment in templates for the Payment Billing Email audience.
| Field | Type | In the picker? |
|---|---|---|
created_at |
Date and time | Yes |
created_by_user_id |
Record ID | Yes |
id |
Record ID | Yes |
is_scheduled |
Yes / no | Yes |
number |
Text | Yes |
updated_at |
Date and time | Yes |
updated_by_user_id |
Record ID | Yes |
account_id |
Value | No |
amount |
Value | Yes |
amount_credited |
Value | No |
amount_paid |
Value | No |
amount_remaining |
Value | No |
cleared_on |
Value | No |
company_id |
Value | No |
company_name |
Value | No |
crm_account_name |
Value | No |
currency_code |
Value | Yes |
date_issued |
Value | No |
direction |
Value | No |
financial_doc_unique_id |
Value | No |
is_contact_notified |
Value | No |
is_deleted |
Value | No |
is_incoming_payment |
Value | No |
is_refund |
Value | No |
nominal_entry_id |
Value | No |
nominal_group_id |
Value | No |
paid_on |
Value | Yes |
payment_method_reference |
Value | No |
processed_on |
Value | No |
sales_ledger_type |
Value | No |
status |
Value | No |
system_of_record |
Value | No |
total |
Value | No |
uri |
Value | No |
uri_pdf |
Value | No |
credit_account_id |
Value | No |
debit_account_id |
Value | No |
description |
Value | No |
invoices |
Value | No |
notes |
Value | Yes |
payment_method_type |
Value | No |
payment_method_type_name |
Value | Yes |
lines |
List of NominalEntry records (loops only) | Yes |
Event staff assignment (staff)
Available as staff in templates for the Event Staff audience (and the single-role Administrators and Instructors audiences).
| Field | Type | In the picker? |
|---|---|---|
account_id |
Record ID | Yes |
bio |
Text | Yes |
contact_id |
Record ID | Yes |
created_at |
Date and time | Yes |
event_id |
Record ID | Yes |
id |
Record ID | Yes |
is_deleted |
Yes / no | Yes |
is_primary |
Yes / no | Yes |
parent_id |
Record ID | Yes |
staff_role_id |
Record ID | Yes |
updated_at |
Date and time | Yes |
account_deleted |
Value | No |
account_name |
Value | No |
booking_type |
Value | No |
company_id |
Value | No |
contact_has_left_company |
Value | No |
contact_mobile_phone_number |
Value | No |
contact_name |
Text | No |
event_deleted |
Value | No |
event_disposition |
Value | No |
event_end |
Value | No |
event_end_tz |
Value | No |
event_start |
Value | No |
event_start_tz |
Value | No |
is_cancelled |
Value | No |
is_staff |
Value | No |
notes |
Value | No |
type |
Value | No |
deltas |
Value | No |
email |
Value | No |
lms_setup_link |
Value | Yes |
lms_setup_url |
Value | Yes |
pay_rate |
Text | Yes |
account |
Related record: Account | Yes |
contact |
Related record: Contact | Yes |
event |
Related record: Event | Yes |
role |
Related record: EventPersonnelRole | Yes |
session_staff |
List of Staff records (loops only) | Yes |
staff_role |
Related record: StaffRole | No |
tasks |
List of Task records (loops only) | Yes |
Training pass (training_pass)
Available as training_pass in templates for the Training Pass Recipient audience.
| Field | Type | In the picker? |
|---|---|---|
account_id |
Record ID | Yes |
contact_id |
Record ID | Yes |
id |
Record ID | Yes |
interest_id |
Record ID | Yes |
is_cancelled |
Yes / no | Yes |
training_pass_type_id |
Record ID | Yes |
training_pass_type_option_id |
Record ID | Yes |
valid_from |
Date and time | Yes |
valid_until |
Date and time | Yes |
valid_from_tz |
Value | No |
valid_until_tz |
Value | No |
training_pass_type_name |
Value | No |
account |
Related record: Account | Yes |
contact |
Related record: Contact | Yes |
opportunity_interest |
Related record: OpportunityInterest | Yes |
training_pass_type |
Related record: TrainingPassType | Yes |
Training token issue (token_issue)
Available as token_issue in templates for the Training Token Point of Contact audience.
| Field | Type | In the picker? |
|---|---|---|
balance |
Number | Yes |
created_on |
Date and time | Yes |
custom_instance_id |
Record ID | Yes |
expire_on |
Date and time | Yes |
expiry_recorded |
Yes / no | Yes |
id |
Record ID | Yes |
identifier |
Identifier | Yes |
initial_balance |
Number | Yes |
opportunity_id |
Record ID | Yes |
token_account_id |
Record ID | Yes |
custom_field_lookup_id |
Value | No |
is_expired |
Value | No |
payment_code |
Value | Yes |
contacts |
List of Contact records (loops only) | Yes |
token_account |
Related record: TokenAccount | Yes |
Related records
These records are not template objects themselves; you reach them by chaining from a template object, as shown in each example. The picker lists a subset of them as expandable groups.
Account
Reachable from contacts, bookings, and events, for example contact.account or event.iht_account.
| Field | Type |
|---|---|
address_country_id |
Record ID |
address_locality |
Text |
address_postcode |
Text |
address_region |
Text |
address_street |
Text |
address_town |
Text |
address_unit |
Text |
bank_details |
Text |
billing_address_country_id |
Record ID |
billing_address_locality |
Text |
billing_address_postcode |
Text |
billing_address_province_code |
Text |
billing_address_region |
Text |
billing_address_street |
Text |
billing_address_town |
Text |
billing_address_unit |
Text |
billing_contact_person |
Text |
billing_email |
Text |
billing_telephone |
Text |
brand_id |
Record ID |
can_self_checkout_by_invoice |
Yes / no |
category_id |
Record ID |
company_id |
Record ID |
company_number |
Text |
created |
Date and time |
custom_instance_id |
Record ID |
default_approver |
Number |
default_price_level_id |
Record ID |
duns_number |
Text |
fax |
Text |
id |
Record ID |
integration_external_id |
Record ID |
is_deleted |
Yes / no |
is_employee |
Yes / no |
is_individual |
Yes / no |
is_partner |
Yes / no |
is_supplier |
Yes / no |
is_venue |
Yes / no |
legacy_external_id |
Record ID |
mobile |
Text |
name |
Text |
no_publicity |
Yes / no |
owner |
Number |
parent_id |
Record ID |
partner_notes |
Text |
partner_type |
Number |
primary_contact_id |
Record ID |
province_code |
Text |
shipping_address_country_id |
Record ID |
shipping_address_locality |
Text |
shipping_address_postcode |
Text |
shipping_address_province_code |
Text |
shipping_address_region |
Text |
shipping_address_street |
Text |
shipping_address_town |
Text |
shipping_address_unit |
Text |
shipping_contact_person |
Text |
shipping_telephone |
Text |
source |
Text |
source_details |
Text |
tags |
Text |
telephone |
Text |
vat_number |
Text |
website |
Text |
company_name |
Value |
custom_field_lookup_id |
Value |
email |
Value |
external_id |
Value |
invoice_contact_name |
Value |
is_customer |
Value |
landline_phone_number |
Value |
notes |
Value |
num_invoices |
Value |
num_purchases |
Value |
root_account_id |
Value |
search_index |
Text |
type |
Value |
updated_at |
Value |
custom |
Custom fields, use custom["Field Name"] |
has_billing_address |
Yes / no |
invoice_address_country |
Value |
invoice_address_country_id |
Value |
invoice_address_locality |
Value |
invoice_address_postcode |
Value |
invoice_address_province_code |
Value |
invoice_address_region |
Value |
invoice_address_street |
Value |
invoice_address_town |
Value |
invoice_address_unit |
Value |
account_sync_status |
Related record: AccountSyncStatus |
address_country |
Related record: Country |
associations |
List of AccountAssociation records (loops only) |
billing_address_country |
Related record: Country |
category |
Related record: AccountCategory |
children |
List of Account records (loops only) |
cohort |
List of LearningCohort records (loops only) |
company |
Related record: Company |
contacts |
List of Contact records (loops only) |
industries |
List of Industry records (loops only) |
invoices |
List of SalesInvoice records (loops only) |
parent |
Related record: Account |
primary_contact |
Related record: Contact |
purchases |
List of PurchaseInvoice records (loops only) |
registrations |
List of Registration records (loops only) |
root_account |
Related record: Account |
sales |
List of NominalGroup records (loops only) |
shipping_address_country |
Related record: Country |
Location
Reachable from events, for example event.location.
| Field | Type |
|---|---|
address_id |
Record ID |
code |
Text |
country_id |
Record ID |
default_tax_id |
Record ID |
description |
Text |
id |
Record ID |
is_custom |
Yes / no |
is_deleted |
Yes / no |
is_enabled |
Yes / no |
latitude |
Number |
longitude |
Number |
name |
Text |
region_id |
Record ID |
status |
Choice |
tz_name |
Text |
updated_at |
Date and time |
website_url |
Text |
address_country_name |
Value |
default_tax_name |
Value |
region_name |
Value |
address |
Related record: Address |
country |
Related record: Country |
default_tax |
Related record: TaxType |
mapped_items |
List of CourseItem records (loops only) |
region |
Related record: Region |
Region
Reachable from locations and events, for example event.location.region.
| Field | Type |
|---|---|
company_id |
Record ID |
default_tax_id |
Record ID |
id |
Record ID |
invoice_numbering |
Choice |
is_deleted |
Yes / no |
is_hidden |
Yes / no |
name |
Text |
has_locations |
Value |
company |
Related record: Company |
countries |
List of Country records (loops only) |
default_tax |
Related record: TaxType |
locations |
List of Location records (loops only) |
Venue
Reachable from events, for example event.venue.
| Field | Type |
|---|---|
account_id |
Record ID |
description |
Text |
id |
Record ID |
latitude |
Number |
location_id |
Record ID |
longitude |
Number |
name |
Text |
is_deleted |
Value |
account |
Related record: Account |
event_location |
Related record: Location |
Address
Reachable from events, for example event.location_address.
| Field | Type |
|---|---|
address_locality |
Text |
address_name |
Text |
address_region |
Text |
address_street |
Text |
address_town |
Text |
address_type |
Text |
address_unit |
Text |
country_id |
Record ID |
id |
Record ID |
postal_code |
Text |
country_name |
Value |
locations |
List of Location records (loops only) |
Country
Reachable from locations and event addresses, for example event.location.country or event.location_address.country.
| Field | Type |
|---|---|
id |
Record ID |
name |
Text |
locations |
List of Location records (loops only) |
regions |
List of Region records (loops only) |
Course template
Reachable from events and learner registrations, for example event.course.
| Field | Type |
|---|---|
achievement_type_id |
Record ID |
allowed_missed_blended_sessions |
Number |
allowed_missed_classroom_sessions |
Number |
blended_achievement_valid_from |
Choice |
blended_require_registration_invoice_to_be_paid |
Yes / no |
classroom_achievement_valid_from |
Choice |
classroom_require_registration_invoice_to_be_paid |
Yes / no |
code |
Text |
company_id |
Record ID |
course_image_document_id |
Record ID |
course_level_id |
Record ID |
course_text_1 |
Text |
course_text_10 |
Text |
course_text_11 |
Text |
course_text_12 |
Text |
course_text_13 |
Text |
course_text_14 |
Text |
course_text_2 |
Text |
course_text_3 |
Text |
course_text_4 |
Text |
course_text_5 |
Text |
course_text_6 |
Text |
course_text_7 |
Text |
course_text_8 |
Text |
course_text_9 |
Text |
cpe |
Text |
created_at_timestamp |
Date and time |
custom_instance_id |
Record ID |
days |
Number |
default_target_fill_rate |
Number |
disposition |
Choice |
event_custom_template_id |
Record ID |
id |
Record ID |
is_archived |
Yes / no |
is_deleted |
Yes / no |
last_modified_timestamp |
Date and time |
lms_achievement_valid_from |
Choice |
lms_autopass |
Yes / no |
lms_links |
Text |
lms_require_registration_invoice_to_be_paid |
Yes / no |
lms_summary |
Text |
locale_id |
Record ID |
max_places |
Number |
min_places |
Number |
persistent |
Yes / no |
pricing_band_id |
Record ID |
purchase_requires_review |
Yes / no |
registration_opens_offset |
Number |
related_courses |
Text |
schedule_id |
Record ID |
session_default_end_time |
Time |
session_default_start_time |
Time |
short_code |
Text |
show_instructors_on_pdf |
Yes / no |
show_level_on_pdf |
Yes / no |
status |
Choice |
title |
Text |
benefits |
Value |
course_level |
Value |
custom_field_lookup_id |
Value |
feedback_survey_id |
Value |
has_approved_instructors |
Number |
image_document_ids |
Value |
introduction |
Value |
lifecycle_state |
Value |
method |
Value |
prerequisites |
Value |
search_index |
Text |
summary |
Value |
target_fill_rate |
Value |
topics |
Value |
union_id |
Text |
custom |
Custom fields, use custom["Field Name"] |
score_template_ids |
Value |
account_associations |
List of AccountAssociation records (loops only) |
categories |
List of CourseCategories records (loops only) |
category_mappings |
List of CategoriesMapTable records (loops only) |
company |
Related record: Company |
course_image_document |
Related record: Document |
course_image_documents |
List of Document records (loops only) |
course_level_relation |
Related record: CourseLevel |
course_resources |
List of CourseResourceMapping records (loops only) |
course_scores_templates |
List of CourseScoresTemplate records (loops only) |
course_template_achievement_types |
List of CourseTemplateAchievementType records (loops only) |
course_template_tags |
List of CourseTemplateTag records (loops only) |
event_custom_template |
Related record: CustomTemplate |
feedback_engine_survey_course_link |
Related record: FeedbackEngineSurveyCourseLink |
included_in_training_pass_types |
List of TrainingPassType records (loops only) |
instructor_rates |
List of InstructorRate records (loops only) |
items |
List of CourseItem records (loops only) |
locale |
Related record: Locale |
prices |
List of CoursePrice records (loops only) |
pricing_band_relation |
Related record: PricingBand |
private_prices |
List of CoursePrivatePrice records (loops only) |
schedule |
Related record: Schedule |
scores_templates |
List of CustomTemplate records (loops only) |
session_templates |
List of SessionTemplate records (loops only) |
staff_requirements |
List of CourseTemplateStaffRequirement records (loops only) |
sub_categories |
List of CourseSubCategories records (loops only) |
task_workflows |
List of CourseTaskWorkflow records (loops only) |
tutor_contacts |
List of Contact records (loops only) |
Currency
Reachable from money-carrying records, for example opportunity.currency.
| Field | Type |
|---|---|
ascii_code |
Text |
html_code |
Text |
id |
Record ID |
is_base |
Yes / no |
is_deleted |
Yes / no |
name |
Text |
symbol |
Text |
code |
Value |
currency_code |
Value |
is_active |
Value |
search_index |
Text |
currency_sync_status |
Related record: CurrencySyncStatus |