SMS templates

You can customise SMS templates to send to users. When certain actions occur (such as user signup), the customised template message is sent to the user. Currently, the following variables are available using liquid.

Template variables

Variable Description

{{link}}

This is the generated magic link (hosted by ReachFive that redirects to the specified URL).

{{verification_code}}

This is the generated verification code sent by SMS.

{{user.email}}

The user’s email address.

{{user.phone_number}}

The mobile number of the user receiving the message.

{{user.lang}}

The default language for the user.

{{user.given_name}}

The user’s given name (first name).

example

Nicole Dubois

{{user.family_name}}

The user’s family name (last name, surname).

example

Nicole Dubois

{{user.suspension_reason}}

The reason why the user was suspended.

Customise the template

You can customise templates from the ReachFive Console. Currently, the following templates are available:

SMS Prerequisites

  • You must have access to the ReachFive Console.

  • You must have the SMS feature enabled.

  • You must have an SMS provider account.

    Please contact support if you do not see SMS enabled.

Signup

Sent after a user signs up via SMS

A link with a code and a specific redirect URL is sent. This verifies the user and redirects the user to the page of your choice.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Signup tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Thanks for signing up.

Your verification code is {{verification_code}}.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Verify phone number

Sent to users who still need to verify their account.

Sometimes, users have created an account without verifying it. In these cases, the accounts may have been around for quite some time or perhaps, they’re new. Either way, this template is sent in order to verify the user account.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Verify phone number tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. It's time to verify your account.

Your verification code is {{verification_code}}.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Phone number update

Sent when a user’s phone number is updated

When the user updates their phone number in the system, an SMS is sent to them containing a verification link.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Phone number update tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your number has been updated.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Password reset

Sent when a user password is reset

The SMS contains a link that can used only once. This link enables the user to change their password on the page of your choice.

This Password reset template is sent when users have started the "Forgot password" flow. Users receive an SMS with the magic link as part of the flow and no follow up SMS is sent after the password is updated.
When the password reset template is used for custom providers, the request payload contains the has_password boolean.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Password reset tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your password reset code is {{verification_code}}. Please use this to reset your password.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Account recovery

Sent when a user is recovering their account

Only displayed if the WebAuthn feature is enabled.

The SMS contains a link that can used only once. This link enables the user to change their password on the page of your choice.

This Account recovery template is sent when users have started the account recovery flow. Users receive an SMS with the magic link as part of the flow and no follow up SMS is sent after the account recovery is completed.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Account recovery tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your account recovery code is {{verification_code}}. Please use this to begin recovering your account.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Password updated

Sent when a user password is updated

When a user’s password is changed, an SMS is sent to them to inform them of this change.

This Password updated template is sent when users log in and update their password themselves. For forgotten passwords, users receive an email with the magic link as part of their forgot password (Password reset) flow and no follow up email is sent after the password is updated.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Password updated tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your password reset code is {{verification_code}}. Please use this to reset your password.

  5. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Signup invitation

Sent to a user so they can sign up to your site.

When a user wants to sign up to your site, they often user their mobiles. This template is the message they’ll get when receiving a signup link via SMS.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Signup invitation tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Link Lifetime. This is in days.

  5. Use the Message section to write your customised template like the example below:

    Howdy {{user.given_name}}, we hope you're well! Please click on the following link to sign up to a flashy new account:

{{link}}

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (days)

The code lifetime in days.

code lifetime days

Link

The signup link.

link

Account suspension

Sent when a user account is suspended

When a user’s account is suspended, an SMS is sent to them informing them of the steps they need to take to reactivate their account.

If a user is indefinitely suspended, they will not receive a reset link. For more information, see the user suspension page.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Account suspension tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your account has been suspended. Please contact your administrator for more information.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Risky Login Notification

Sent to user when login attempt is deemed risky

This template should be used to notify users that a login attempt from their account is considered unusual or risky. For users that haven’t activated Multi-factor Authentication with Risk-based Authentication, the SMS is sent every time a user attempts to log in.

To learn more, see Risk-based Authentication.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Risky Login Notification tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Enter the Verification Code Lifetime. This is in seconds.

  5. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. There has been an unusual login attempt on your account. Please contact your system administrator if this was not you trying to sign in. Otherwise, you can ignore this message.

  6. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id

Code Lifetime (seconds)

The code lifetime in seconds.

code lifetime

Leaked Credentials Notification

Sent to user when they attempt to sign in with leaked credentials

This template should be used to notify users that they attempted to sign in with leaked credentials.

To learn more, see Data Breach Detection.

  1. Go to Settings  SMS  Templates on your ReachFive Console.

  2. Toggle to the Leaked Credentials Notification tab.

  3. Enable the template by ticking the Enabled checkbox.

  4. Use the Message section to write your customised template like the example below:

    Hi {{user.given_name}}. Your credentials have been identified in a potential data breach. Please contact the site administrator to unlock your account.

  5. Don’t forget to Save your input.

Custom provider templates

If you have configured a custom provider, your templates will be different and only contain the following fields:

Field Description

Enabled

Checkbox to enable the template.

enabled

Template ID

The ID that you assign to the template.

template id