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:
- The email customization for the language specified in the
language
query parameter. If Custom languages for Okta Email Templates is enabled and thelanguage
parameter is an additional language, the test email uses the customization corresponding to the language. - The email template's default customization.
- The email template’s default content, translated to the current user's language.
Servers
- https://{yourOktaDomain}
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
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.