changeCustomerPassword mutation

Use the changeCustomerPassword mutation to change the password for the logged-in customer.

To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use session authentication.

Syntax

1
2
3
4
5
6
7
8
mutation {
  changeCustomerPassword(
    currentPassword: String!
    newPassword: String!
  ) {
    Customer
  }
}

Example usage

The following call updates the customer’s password.

Request:

1
2
3
4
5
6
7
8
9
mutation {
  changeCustomerPassword(
    currentPassword: "roni_cost3@example.com"
    newPassword: "roni_cost4@example.com"
  ) {
    id
    email
  }
}

Response:

1
2
3
4
5
6
7
8
{
  "data": {
    "changeCustomerPassword": {
      "id": 1,
      "email": "roni_cost@example.com"
    }
  }
}

Input attributes

The changeCustomerPassword mutation requires the following inputs:

Output attributes

The changeCustomerPassword mutation returns the customer object.

CustomerAddress attributes

The values assigned to attributes such as firstname and lastname in this object may be different from those defined in the Customer object.

The CustomerAddress output returns the following attributes:

CustomerAddressAttribute attributes

The CustomerAddressAttribute output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:

CustomerAddressRegion attributes

The customerAddressRegion output returns the following attributes:

Errors

Related topics

• customer query
• createCustomer mutation
• updateCustomer mutation