POST /api/v1/brands/{brandId}/templates/email/{templateName}/test

Sends a test email to the current user's primary and secondary email addresses. The email content is selected based on the following priority:

  1. The email customization for the language specified in the language query parameter If Custom languages for Okta Email Templates is enabled and the language parameter is an additional language, the test email uses the customization corresponding to the language.
  2. The email template's default customization
  3. The email template's default content, translated to the current user's language

Note: Super admins can view customized email templates with the Send a test email request. However, when custom email templates are sent to super admins as part of actual email notification flows, the customizations aren't applied. Instead, the default email template is used. This only applies to super admins.

Servers

Path parameters

Name Type Required Description
brandId String Yes

The ID of the brand

templateName String Yes

The name of the email template

Query parameters

Name Type Required Description
language String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.