Send an Okta Branded Activation Email via API Using a Custom Domain

Activating users from the Okta Admin Console automatically associates the action with the default domain and sends emails from noreply@okta.com. To send a branded activation email, administrators must use an API call with a URL that matches the active custom domain. This ensures the user receives an email associated with the specific brand rather than the default Okta domain.

• Okta Identity Engine (OIE)
• Okta Classic Engine
• Application Programming Interface (API) Calls
• Postman
• Branded Emails
• Custom Email Templates

How do administrators send a branded activation email via API?

Trigger a branded activation email by executing a user lifecycle activation API call that incorporates the active custom domain URL instead of the default Okta domain.

https://<CustomDomainURL>/api/v1/users/userId/lifecycle/activate?sendEmail=true

NOTE: The custom domain must be active for the brand-specific email to function correctly. Furthermore, the user must trigger the email while on the custom domain associated with the brand, or the action must occur via an API call.