Identity Update Message Template

On this page

FusionAuth sends this message when a user's phone number changes. FusionAuth sends the message to the previous phone number, then to the new phone number. When the change removes the phone number, only the previous phone number gets the message. Assign the template in Identity update on the Tenants -> Your Tenant -> Identities tab. To override the template for one Application, set the template on the Applications -> Your Application -> Identities tab.

Example Template#

FusionAuth ships no default for this template. Start from the following example:

[#-- FusionAuth sends this message to the previous phone number and to the new one --]
[#if (event.previousLoginId)?? && (event.newLoginId)??]
The phone number for your account changed from ${event.previousLoginId} to ${event.newLoginId}.
[#elseif (event.previousLoginId)??]
The phone number ${event.previousLoginId} was removed from your account.
[#else]
The phone number for your account changed.
[/#if]
If you didn't make this change, contact support right away.

- FusionAuth Admin

Replacement Variables#

application
  • Type: Application

The Application object. For field definitions, see the Application API.

The variable is present only when the request that sends the message identifies an Application. Check for the variable before you use it:

[#if application??]
  ${application.name}
[/#if]
baseUrl
  • Type: String
  • Available since 1.68.0

The base URL for links in the message. FusionAuth uses the Application baseURL, then the Tenant baseURL, then http://localhost:9011.

event
  • Type: Object

The User Identity Update event. The previous phone number is in event.previousLoginId, and the new phone number is in event.newLoginId. For field definitions, see the User Identity Update event reference.

phoneNumber
  • Type: String
  • Available since 1.59.0

The phone number FusionAuth sends the message to: the previous phone number in the first message, and the new phone number in the second. The Generic messenger request has the same value in phoneNumber.

tenant
  • Type: Tenant

The Tenant object. For field definitions, see the Tenant API.

user
  • Type: User

The User object for the recipient. For field definitions, see the User API.