Authentication > Auth > customersAuthPasswordReset
Commerce APIAuthenticationAuthcustomersAuthPasswordReset
customersAuthPasswordReset
POST:customers/auth/password/reset.json

Description

Request email with password change token for a customer.

Permission bit: "customers.modify"

Topic: Auth

Arguments

data: CustomerPasswordReset!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

email: String!

The email address of the customer

Example: "bob.norman@hostmail.com"

Valid when: email is not empty

Valid when: email's length doesn't exceed 250 characters


Result

Boolean

Preview (typescript)

Loading module