customization_preview
Creates, updates, deletes, gets or lists a customization_preview resource.
Overview​
| Name | customization_preview |
| Type | Resource |
| Id | okta.brands.customization_preview |
Fields​
The following fields are returned by SELECT queries:
- get_customization_preview
Successfully generated a preview of the email customization.
| Name | Datatype | Description |
|---|---|---|
_links | object | Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
body | string | The email's HTML body |
subject | string | The email's subject |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_customization_preview | select | brandId, templateName, customizationId, subdomain | Retrieves a Preview of an Email Customization. All variable references are populated from the current user's context. For example, ${user.profile.firstName}.<x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests for the preview of an additional language customization by ID return a 404 Not Found error response. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
brandId | string | The ID of the brand |
customizationId | string | The ID of the email customization |
subdomain | string | (default: my-org) |
templateName | string | The name of the email template |
SELECT examples​
- get_customization_preview
Retrieves a Preview of an Email Customization. All variable references are populated from the current user's context. For example, ${user.profile.firstName}.
<x-lifecycle class="ea"></x-lifecycle> If Custom languages for Okta Email Templates is disabled, requests for the preview of an additional language customization by ID return a 404 Not Found error response.
SELECT
_links,
body,
subject
FROM okta.brands.customization_preview
WHERE brandId = '{{ brandId }}' -- required
AND templateName = '{{ templateName }}' -- required
AND customizationId = '{{ customizationId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;