Skip to main content

PasswordResetLinkEmailInput

Password reset email configuration for user account recovery.

Extends email event input with specific fields needed for password reset functionality, including user identification, redirect handling, and localization options.

input PasswordResetLinkEmailInput {
  type: EmailEventType!
  siteId: Int
  orderId: Int
  userId: Int
  letterId: String
  subject: String
  content: String
  from: EmailSendContactInput
  attachments: [Base64FileInput!]
  variables: JSONObject
  language: String
  email: String!
  redirectUrl: String
  linkText: String
}

Fields​

PasswordResetLinkEmailInput.type ● EmailEventType! non-null enum​

Classification of the email event being triggered.

Determines the purpose and context of the email, enabling appropriate template selection and content personalization based on the business scenario.

PasswordResetLinkEmailInput.siteId ● Int scalar​

Legacy site identifier for email context.

Previously used to determine site-specific email configuration, now deprecated as site context is derived from other inputs automatically.

PasswordResetLinkEmailInput.orderId ● Int scalar​

The id of the order to use when triggering an event of type orderconfirm

PasswordResetLinkEmailInput.userId ● Int scalar​

User identifier for recipient determination.

Used to identify the email recipient when the user cannot be derived from other context inputs like order or contact information.

PasswordResetLinkEmailInput.letterId ● String scalar​

Campaign letter identifier for marketing emails.

Required when triggering campaign-type events, references the specific marketing letter or campaign content to be sent.

PasswordResetLinkEmailInput.subject ● String scalar​

Custom email subject line override.

Provides a specific subject line when it cannot be derived from template configuration or other context inputs, enabling dynamic subject customization.

PasswordResetLinkEmailInput.content ● String scalar​

Custom email content override.

Provides specific email content when it cannot be derived from template configuration or other context inputs, enabling dynamic content customization.

PasswordResetLinkEmailInput.from ● EmailSendContactInput input​

Email sender information override.

Specifies the email sender when it cannot be derived from template configuration or other context inputs, enabling flexible sender customization.

PasswordResetLinkEmailInput.attachments ● [Base64FileInput!] list input​

File attachments for the email.

Base64-encoded files that will be attached to the email message, supporting various file types for comprehensive communication needs.

PasswordResetLinkEmailInput.variables ● JSONObject scalar​

Template variable data for dynamic content.

JSON object containing key-value pairs that will be used for Handlebars variable substitution in the email template, enabling personalized and context-specific content generation.

Validation: Must be valid JSON format.

PasswordResetLinkEmailInput.language ● String scalar​

Language code for email localization.

ISO 639-1 language code determining which language version of the password reset email template to use.

Validation: Must be exactly 2 characters long.

PasswordResetLinkEmailInput.email ● String! non-null scalar​

User email address for password reset.

Valid email address of the user account that requires password reset, must match an existing user account in the system.

Validation: Must be a valid email format.

PasswordResetLinkEmailInput.redirectUrl ● String scalar​

Post-reset redirect destination URL.

The page URL where the user will be redirected after successfully changing their password, enabling seamless user experience and proper application flow.

PasswordResetLinkEmailInput.linkText ● String scalar​

Custom link text for the reset button.

Text that will be displayed on the password reset link or button in the email, allowing customization of the call-to-action message.

Member Of​

publishPasswordResetEmailEvent mutation