• management
• SDK
• VerificationEmailClient

Class VerificationEmailClient

Index

Constructors

constructor

Methods

create

Properties

_options

Constructors

constructor

new VerificationEmailClient(options: BaseClientOptions): VerificationEmailClient

Parameters

• options: BaseClientOptions

Returns VerificationEmailClient

Methods

create

create(
request: CreateVerificationEmailRequestContent,
requestOptions?: VerificationEmailClient.RequestOptions,
): HttpResponsePromise<CreateVerificationEmailResponseContent>

Send an email to the specified user that asks them to click a link to verify their email address.

Note: You must have the Status toggle enabled for the verification email template for the email to be sent.

Parameters

• request: CreateVerificationEmailRequestContent
• OptionalrequestOptions: VerificationEmailClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateVerificationEmailResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.jobs.verificationEmail.create({ user_id: "user_id" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods create Properties _options