Copy a Custom Email Sender Domain to the Okta Default Brand Using the API
Last Updated:
Overview
When a custom email sender is configured for a custom brand, copying the email sender domain to the Okta subdomain is not possible through the Admin Console. Administrators must use the Okta API to copy the sender email to the default brand.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Custom email
Solution
What API calls copy the custom email sender domain to the Okta default brand?
Retrieve the verified email domain ID and the default brand ID using an API client, then update the brand ID via an API call to copy the custom email sender domain to the Okta default brand.
- Navigate to the Okta Public API Collections.
- Sign in to Postman.
- Add the collection to the desired workspace using the Postman web or desktop application.
- Set the correct parameters for the URL and authorization token.
- Navigate to Email Domains > List all Email Domains to retrieve a full list of the custom email sender domains configured on the tenant.
- Search for the domain that has the following property set to Verified and copy the ID of the verified email domain:
"validationStatus": "VERIFIED" - Navigate to Brands > Brand Operations > Get Brands to find the ID of the Default Okta brand on the tenant.
- Search for the brand that has the following property set to True and copy the ID of the associated brand:
"isDefault": true - Navigate to Brands > Brand Operations > Update/Replace Brand.
- Update the brand ID in the URL with the ID of the default brand within the tenant.
- Update the custom email domain ID in the payload of the API call with the verified email ID retrieved in step 6:
"name": "Brand Name","emailDomainId": "<custom_email_domain_ID>" - Run the API call.
- Navigate to Customizations > Brands in the Admin Console to verify the change.
- Verify that the Email Address field displays the custom email sender applied to both the custom domain and the Default Okta domain.
