updateCustomer mutation

Magento recommends using the updateCustomerV2 mutation to update a customer.

The updateCustomer mutation updates the customer’s personal information.

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: {updateCustomer(input: CustomerInput!) {CustomerOutput}}

Example usage

The following call updates the first name and email address for a specific customer.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
mutation {
  updateCustomer(
    input: {
      firstname: "Rob"
      email: "robloblaw@example.com"
    }
  ) {
    customer {
      firstname
      email
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
{
  "data": {
    "updateCustomer": {
      "customer": {
        "firstname": "Rob",
        "email": "robloblaw@example.com"
      }
    }
  }
}

Input attributes

The following table lists the attributes you can use as input for the updateCustomer mutation. The Customer attributes table lists the attributes Magento returns.

Output attributes

The updateCustomer mutation returns the CustomerOutput object.

The following table lists the top-level attributes of the customer object. See the customer query for complete details about this object.

For B2B, company administrators and users can have the following attributes.

Errors

Related topics

• customer query
• createCustomer mutation
• createCustomerAddress mutation
• updateCustomerAddress mutation
• deleteCustomerAddress mutation