BigCommerce Docs

mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: UpdateCustomerInput) {
  updateCustomer(reCaptchaV2: $reCaptchaV2, input: $input) {
    customer {
      entityId
      company
      customerGroupId
      customerGroupName
      email
      firstName
      lastName
      notes
      phone
      taxExemptCategory
    }
    errors
  }
}

{
  "reCaptchaV2": {
    "token": "example"
  },
  "input": {
    "firstName": "example",
    "lastName": "example",
    "email": "example",
    "phone": "example",
    "company": "example",
    "formFields": {
      "checkboxes": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityIds": [
            0
          ]
        }
      ],
      "multipleChoices": [
        {
          "fieldEntityId": 0,
          "fieldValueEntityId": 0
        }
      ],
      "numbers": [
        {
          "fieldEntityId": 0,
          "number": 0
        }
      ],
      "dates": [
        {
          "fieldEntityId": 0,
          "date": "DateTime"
        }
      ],
      "texts": [
        {
          "fieldEntityId": 0,
          "text": "example"
        }
      ],
      "multilineTexts": [
        {
          "fieldEntityId": 0,
          "multilineText": "example"
        }
      ],
      "passwords": [
        {
          "fieldEntityId": 0,
          "password": "example"
        }
      ]
    }
  }
}

{
  "data": {
    "updateCustomer": {
      "customer": {
        "entityId": 0,
        "company": "example",
        "customerGroupId": 0,
        "customerGroupName": "example",
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "notes": "example",
        "phone": "example",
        "taxExemptCategory": "example"
      },
      "errors": [
        {
          "message": "example"
        }
      ]
    }
  }
}

Update a customer.

Arguments

reCaptchaV2ReCaptchaV2InputOptional

Recaptcha token.

inputUpdateCustomerInputRequired

Input for the customer update operation.

Returns

an UpdateCustomerResult

errorslist of UpdateCustomerErrors

The errors, if any, that occurred during the update operation.

customerCustomer

The customer that was updated.

1	{
2	"reCaptchaV2": {
3	"token": "example"
4	},
5	"input": {
6	"firstName": "example",
7	"lastName": "example",
8	"email": "example",
9	"phone": "example",
10	"company": "example",
11	"formFields": {
12	"checkboxes": [
13	{
14	"fieldEntityId": 0,
15	"fieldValueEntityIds": [
16	0
17	]
18	}
19	],
20	"multipleChoices": [
21	{
22	"fieldEntityId": 0,
23	"fieldValueEntityId": 0
24	}
25	],
26	"numbers": [
27	{
28	"fieldEntityId": 0,
29	"number": 0
30	}
31	],
32	"dates": [
33	{
34	"fieldEntityId": 0,
35	"date": "DateTime"
36	}
37	],
38	"texts": [
39	{
40	"fieldEntityId": 0,
41	"text": "example"
42	}
43	],
44	"multilineTexts": [
45	{
46	"fieldEntityId": 0,
47	"multilineText": "example"
48	}
49	],
50	"passwords": [
51	{
52	"fieldEntityId": 0,
53	"password": "example"
54	}
55	]
56	}
57	}
58	}