updateCustomerV2 mutation
The updateCustomerV2
mutation updates the personal information in an existing customer account. Use the updateCustomerEmail
mutation to update the customer’s email address.
The updateCustomerV2
mutation supersedes the updateCustomer
mutation as the means to update a customer account. The input objects differ between these two mutations. The updateCustomer
mutation required the CustomerInput
object, as did the createCustomer
mutation. Updating a customer does not require any specific attribute, while several attributes are required when you create a customer. You could not determine this by looking at the schema for those mutations. The updateCustomerV2
mutation requires the CustomerUpdateInput
object, which it does not share with the createCustomerV2
mutation.
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
mutation: {updateCustomerV2(input: CustomerUpdateInput!) {CustomerOutput}}
Example usage
The following call updates the first name and the newsletter subscription status for a specific customer.
Request:
1
2
3
4
5
6
7
8
9
10
11
12
13
mutation {
updateCustomerV2(
input: {
firstname: "Robert"
is_subscribed: false
}
) {
customer {
firstname
is_subscribed
}
}
}
Response:
1
2
3
4
5
6
7
8
9
10
{
"data": {
"updateCustomerV2": {
"customer": {
"firstname": "Robert",
"is_subscribed": false
}
}
}
}
Input attributes
The following table lists the attributes you can use as input for the updateCustomerV2
mutation.
Attribute | Data Type | Description |
---|---|---|
date_of_birth |
String | The customer’s date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. |
dob |
String | Deprecated. Use date_of_birth instead. The customer’s date of birth |
firstname |
String | The customer’s first name |
gender |
Int | The customer’s gender (Male - 1, Female - 2) |
is_subscribed |
Boolean | Indicates whether the customer subscribes to the store’s newsletter |
lastname |
String | The customer’s last name |
middlename |
String | The customer’s middle name |
password |
String | The customer’s password |
prefix |
String | An honorific, such as Dr., Mr., or Mrs. |
suffix |
String | A value such as Sr., Jr., or III |
taxvat |
String | The customer’s Tax/VAT number (for corporate customers) |
Output attributes
The CustomerOutput
object contains the Customer
object.
The following table lists the top-level attributes of the customer
object. See the customer
query for complete details about this object.
Attribute | Data Type | Description |
---|---|---|
addresses |
CustomerAddress | An array containing the customer’s shipping and billing addresses |
created_at |
String | Timestamp indicating when the account was created |
date_of_birth |
String | The customer’s date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. |
default_billing |
String | The ID assigned to the billing address |
default_shipping |
String | The ID assigned to the shipping address |
dob |
String | Deprecated. Use date_of_birth instead. The customer’s date of birth |
email |
String | The customer’s email address |
firstname |
String | The customer’s first name |
gender |
Int | The customer’s gender (Male - 1, Female - 2) |
group_id |
Int | Deprecated. This attribute is not applicable for GraphQL. The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) |
id |
Int | Deprecated. This attribute is not applicable for GraphQL.The ID assigned to the customer |
is_subscribed |
Boolean | Indicates whether the customer is subscribed to the company’s newsletter |
lastname |
String | The customer’s family name |
middlename |
String | The customer’s middle name |
orders(<FilterCriteria>) |
[CustomerOrders] | A list of the customer’s placed orders |
prefix |
String | An honorific, such as Dr., Mr., or Mrs. |
reviews(pageSize: Int = 20 currentPage: Int = 1) |
[ProductReviews]! | The list of reviews of the product |
reward_points |
[RewardPoints] | Details about the customer’s reward points |
suffix |
String | A value such as Sr., Jr., or III |
taxvat |
String | The customer’s Tax/VAT number (for corporate customers) |
wishlist |
[Wishlist]! | Contains the contents of the customer’s wish lists |