Skip to main content

Custom email template for distributions

Updated over a month ago

What are Custom Email Templates?

Custom email templates let you send branded, personalized invitations and reminders for your research studies.
When configured for your research domain, these templates allow you to pipe in dynamic data like participant profile attributes or custom variables directly into your email content.

You can choose the default Rival template or a custom template uploaded to your research domain.

Piping Dynamic Attributes

You can insert variables into your email template using handlebar functions wrapped in {{ }}.
These pull values from the participant profile, custom variables, or distribution info.

Profile Attributes

Only text and numeric profile attributes are available for piping into email templates.

  • Without default value

    {{profile.<attributeName>.value}}

    Example
    {{profile.first_name.value}}
  • With default value

    {{choose profile.<attributeName>.value '<Placeholder Value>'}}

    Examples
    {{choose profile.customer_type.value 'Customer'}}
    {{choose profile.loyalty_points.value 0}}

Custom Variables for Email Template

  • Without default value

    {{parameters.<parameterName>}}
    Note: Parameter names must have no spaces and use underscores.

    Example
    {{parameters.EmailMessage}}

  • With default value

    {{choose parameters.<parameterName> '<Placeholder Value>'}}

    Example
    {{choose parameters.EmailMessage 'You have been invited!'}}

Note:
Custom parameters cannot include HTML formatting, line breaks, or special formatting—plain text only

Distribution Values

  • Without default value

    {{distribution.<urlName>}}
    Available urlName options
    unsubscribeUrl
    chatUrl

    Example
    {{distribution.chatUrl}}
  • With default value

    {{choose distribution.<urlName> '<Default Value>'}}

    Example
    {{choose distribution.chatUrl 'https://example.com/'}}

How to Use a Custom Email Template

  1. Check Availability

    • Go to the Invitation or Reminder drawer in your chat.

    • Look for the Template dropdown.

  2. Select Your Template

    • If using Default, Rival’s template will be applied.

    • If you have a custom template, select it from the dropdown.

  3. Preview the Template

    • Click Preview to see how it will look with dynamic variables.

  4. Test the Template

    • Click Test Email to send a copy to yourself before distribution.

  5. Need a New Template?

    • Follow the process in the Custom Template Upload Guide to request DevOps upload.

How to Request a Custom Template Upload

  1. Prepare the HTML template

    • Include dynamic variables as needed (see examples above).

    • Finalize subject line, button label, and body content.

  2. Open a Tech Support Ticket

    • Request to upload your template to the relevant research domain.

  3. Include the following assets in your ticket:

    • Research Domain URL

    • Template Name

    • List of custom variables and default values

    • Default Subject Line for this template

    • Attach the finalized HTML file along with image assets used in the template

    • Image assets (attach files) if you need DevOps to host them

  4. After upload by DevOps:

    • The template will appear in the template dropdown during distribution setup.

    • You can preview it in the platform before sending.

    • Use the Test Email button to send yourself a sample.

Key Benefits

  • Full flexibility to align emails with your brand

  • Dynamic, personalized content for participants

  • Easy preview and test functionality before launch

Did this answer your question?