email_default_preview
Creates, updates, deletes, gets or lists an email_default_preview resource.
Overview​
| Name | email_default_preview |
| Type | Resource |
| Id | okta.brands.email_default_preview |
Fields​
The following fields are returned by SELECT queries:
- get_email_default_preview
Successfully generated a preview of the email template's default content.
| 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_email_default_preview | select | brandId, templateName, subdomain | language | Retrieves a preview of an Email Template's default content. All variable references are populated using the current user's context. For example, ${user.profile.firstName}.<x-lifecycle class="ea"></x-lifecycle> Defaults to the current user's language given the following: - Custom languages for Okta Email Templates is enabled - An additional language is specified for the language parameter |
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 |
subdomain | string | (default: my-org) |
templateName | string | The name of the email template |
language | string | The language to use for the email. Defaults to the current user's language if unspecified. |
SELECT examples​
- get_email_default_preview
Retrieves a preview of an Email Template's default content. All variable references are populated using the current user's context. For example, ${user.profile.firstName}.
<x-lifecycle class="ea"></x-lifecycle> Defaults to the current user's language given the following:
- Custom languages for Okta Email Templates is enabled
- An additional language is specified for the language parameter
SELECT
_links,
body,
subject
FROM okta.brands.email_default_preview
WHERE brandId = '{{ brandId }}' -- required
AND templateName = '{{ templateName }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND language = '{{ language }}'
;