createCustomer mutation

Magento recommends using the createCustomerV2 mutation to create a customer.

The createCustomer mutation creates a new 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

mutation: {createCustomer(input: CustomerInput!) {CustomerOutput}}

Example usage

The following call creates a new customer.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
mutation {
  createCustomer(
    input: {
      firstname: "Bob"
      lastname: "Loblaw"
      email: "bobloblaw@example.com"
      password: "b0bl0bl@w"
      is_subscribed: true
    }
  ) {
    customer {
      firstname
      lastname
      email
      is_subscribed
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "data": {
    "createCustomer": {
      "customer": {
        "firstname": "Bob",
        "lastname": "Loblaw",
        "email": "bobloblaw@example.com",
        "is_subscribed": true
      }
    }
  }
}

Input attributes

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

Output attributes

The createCustomer 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
• updateCustomer mutation
• createCustomerAddress mutation
• updateCustomerAddress mutation
• deleteCustomerAddress mutation