email_default_content
Creates, updates, deletes, gets or lists an email_default_content resource.
Overview​
| Name | email_default_content |
| Type | Resource |
| Id | okta.brands.email_default_content |
Fields​
The following fields are returned by SELECT queries:
- get_email_default_content
Successfully retrieved 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 HTML body of the email. May contain variable references. <x-lifecycle class="ea"></x-lifecycle> Not required if Custom languages for Okta Email Templates is enabled. A null body is replaced with a default value from one of the following in priority order: 1. An existing default email customization, if one exists 2. Okta-provided translated content for the specified language, if one exists 3. Okta-provided translated content for the brand locale, if it's set 4. Okta-provided content in English |
subject | string | The email subject. May contain variable references. <x-lifecycle class="ea"></x-lifecycle> Not required if Custom languages for Okta Email Templates is enabled. A null subject is replaced with a default value from one of the following in priority order: 1. An existing default email customization, if one exists 2. Okta-provided translated content for the specified language, if one exists 3. Okta-provided translated content for the brand locale, if it's set 4. Okta-provided content in English |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_email_default_content | select | brandId, templateName, subdomain | language | Retrieves an email template's default content <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_content
Retrieves an email template's default content
<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_content
WHERE brandId = '{{ brandId }}' -- required
AND templateName = '{{ templateName }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND language = '{{ language }}'
;