• management
• SDK
• EmailTemplatesClient

Class EmailTemplatesClient

Index

Constructors

constructor

Methods

creategetsetupdate

Properties

_options

Constructors

constructor

new EmailTemplatesClient(options: BaseClientOptions): EmailTemplatesClient

Parameters

• options: BaseClientOptions

Returns EmailTemplatesClient

Methods

create

create(
request: CreateEmailTemplateRequestContent,
requestOptions?: EmailTemplatesClient.RequestOptions,
): HttpResponsePromise<CreateEmailTemplateResponseContent>

Create an email template.

Parameters

• request: CreateEmailTemplateRequestContent
• OptionalrequestOptions: EmailTemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateEmailTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.emailTemplates.create({ template: "verify_email" })Copy

get

get(
templateName: Management.EmailTemplateNameEnum,
requestOptions?: EmailTemplatesClient.RequestOptions,
): HttpResponsePromise<GetEmailTemplateResponseContent>

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, and async_approval. The names change_password, and password_reset are also supported for legacy scenarios.

Parameters

• templateName: Management.EmailTemplateNameEnum

Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).

• OptionalrequestOptions: EmailTemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetEmailTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.emailTemplates.get("verify_email")Copy

set

set(
templateName: Management.EmailTemplateNameEnum,
request: SetEmailTemplateRequestContent,
requestOptions?: EmailTemplatesClient.RequestOptions,
): HttpResponsePromise<SetEmailTemplateResponseContent>

Update an email template.

Parameters

• templateName: Management.EmailTemplateNameEnum

Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).

• request: SetEmailTemplateRequestContent
• OptionalrequestOptions: EmailTemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<SetEmailTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.emailTemplates.set("verify_email", { template: "verify_email" })Copy

update

update(
templateName: Management.EmailTemplateNameEnum,
request?: UpdateEmailTemplateRequestContent,
requestOptions?: EmailTemplatesClient.RequestOptions,
): HttpResponsePromise<UpdateEmailTemplateResponseContent>

Modify an email template.

Parameters

• templateName: Management.EmailTemplateNameEnum

Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).

• request: UpdateEmailTemplateRequestContent = {}
• OptionalrequestOptions: EmailTemplatesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateEmailTemplateResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.emailTemplates.update("verify_email")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods creategetsetupdate Properties _options