This article describes how to leverage different activation email templates based on a User Profile Attribute Value.
- Custom Email Templates
- Universal Directory
While Okta does not provide an out-of-the-box solution, the best way to send users different activation emails (based on different app assignments/roles within the organization) would be to assign different values for the locale attribute for the user subset in question.
For example, users with the locale value en_US should receive the template activation email 1, and users with a different locale value should receive the template activation email 2.
More details can be found in Mapping Location Attribute from Profile Master to Locale attribute in Okta profile results in a null value.
This is just a small list of available locale values that can be used during the account creation process:
- Spanish: es_ES
- Czech: cs_CS
- German: de_DE
- Russian: ru_RU
- Danish: da_DA
If Admins are creating a user via an API call, the following example can be utilized:
{{url}}/api/v1/users?activate=true
Body: {
"profile": {
"firstName": "Test",
"lastName": "User",
"email": "test.user@domain.com",
"login": "test.user@domain.com",
"locale": "es_ES"
}
}
It is recommended to test this flow on a Preview environment before deploying it in Production.
NOTE: Okta only supports sending different activation email translations based on the standard locale attribute in the user’s profile. The system uses the value of the locale attribute (such as fr_FR for French, es_ES for Spanish, etc.) to determine which language version of the activation email to send. There is no built-in support for using other custom user profile attributes to select the email translation. To submit an idea as a feature request for consideration in the Okta Product Roadmap, refer to the following article for more information about Okta Ideas: How to Submit a Feature or Enhancement Request using Okta Ideas.
