<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
How to Get Email Customizations Using API Calls
Okta Classic Engine
Okta Identity Engine
Administration
Overview

This article is for the Okta Admins who may want to view, update, or create email customizations using API calls. The following procedure/steps can be used to get the required IDs.

Applies To
  • Email
  • Customization
  • API
Solution

The following calls are intended to be used in order to use the ID from the previous call in the next call. For example, the Get Brands call should list all brands on the tenant. Then, take the Brand ID of the desired brand to modify from the output of the first call and plug it into the next API call to list the email templates for that brand.  The IDs to look for are brandId, templateName, and customizationId :

  1. Get brands (get brandID): {{url}}/api/v1/brands
  2. List email templates (get templateName): {{url}}/api/v1/brands/{{brandId}}/templates/email
  3. Get email template: {{url}}/api/v1/brands/{{brandId}}/templates/email/{{templateName}}
  4. List email customizations (get customizationId): {{url}}/api/v1/brands/{{brandId}}/templates/email/{{templateName}}/customizations
  5. Get email customization: {{url}}/api/v1/brands/{{brandId}}/templates/email/{{templateName}}/customizations/{{customizationId}}
Loading
How to Get Email Customizations Using API Calls