Retrieve a Preview of the Email Template Default Content

GET {{baseUrl}}/api/v1/brands/:brandId/templates/email/:templateName/default-content/preview

Retrieves a preview of an email template's default content. All variable references (e.g., ${user.profile.firstName}) are populated using the current user's context.

Request Params

KeyDatatypeRequiredDescription
languagestringThe language to use for the email. Defaults to the current user's language if unspecified.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"subject":"Welcome to Okta!","body":"\u003c!DOCTYPE html\u003e\u003chtml\u003e\u003cbody\u003e\u003cp\u003eHello, John. Click \u003ca href=\"https://{yourOktaDomain}/...\"\u003ehere\u003c/a\u003e to activate your account.\u003c/body\u003e\u003c/html\u003e","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/default-content/preview","hints":{"allow":["GET"]}},"template":{"href":"https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation","hints":{"allow":["GET"]}},"defaultContent":{"href":"https://{yourOktaDomain}/api/v1/brands/{brandId}/templates/email/UserActivation/test/default-content","hints":{"allow":["POST"]}}}}