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

Creates a new Email Customization

If Custom languages for Okta Email Templates is enabled, you can create a customization for any BCP47 language in addition to the Okta-supported languages.

Servers

Path parameters

Name Type Required Description
brandId String Yes

The ID of the brand

templateName String Yes

The name of the email template

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

A unique identifier for this email customization

created String No

The UTC time at which this email customization was created.

body String Yes

The HTML body of the email. May contain variable references.

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
isDefault Boolean No

Whether this is the default customization for the email template. Each customized email template must have exactly one default customization. Defaults to true for the first customization and false thereafter.

subject String Yes

The email subject. May contain variable references.

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
lastUpdated String No

The UTC time at which this email customization was last updated.

language String Yes

The language specified as an IETF BCP 47 language tag

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.