Custom Email Templates
These endpoints allow you to programmatically manage email customizations.
Okta provides many customizable email templates. For example, the UserActivation email template allows users to activate their account. Use email customizations to override a template's default content. See the list of email templates.
Each template has default content that Okta translates to any one of the supported languages. The following settings determine the language for emails sent from Okta to a user, if the user hasn't selected a specific display language:
- The user's locale property value (if specified)
- The org's display language
See Supported languages.
The following constraints apply to email customizations:
- If an email template has any customizations at all, exactly one of them must be the default (where
isDefaultistrue). Okta uses the default customization when no other customization applies to the user's language settings. - Each email template can have only one customization for each supported language.
Use the BCP 47 format to enable more locales than Okta's 27 default languages.
Once you create a customization with the new locale, the locale appears in the Admin Console along with the default-supported locales.
Include null in the subject or body of the email customization. Okta replaces null with a default value based on the following order of priority:
- An existing default email customization, if one exists
- Okta-provided translated content for the specified language, if one exists
- Okta-provided translated content for the brand locale, if it's set
- Okta-provided content in English