API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

customerUpdate mutation

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Updates an existing customer.

Required access

unauthenticated_write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customer ( CustomerUpdateInput! ) required

The customer object input.

customerAccessToken ( String! ) required

The access token used to identify the customer.

CustomerUpdateInput fields

  • acceptsMarketing (Boolean)

    Indicates whether the customer has consented to be sent marketing material via email.

  • email (String)

    The customer’s email.

  • firstName (String)

    The customer’s first name.

  • lastName (String)

    The customer’s last name.

  • password (String)

    The login password used by the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111. To remove the phone number, specify null.

Return fields

  • customer (Customer)

    The updated customer object.

  • customerAccessToken (CustomerAccessToken)

    The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

  • customerUserErrors ([CustomerUserError!]!)

    List of errors that occurred executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    List of errors that occurred executing the mutation.

    Deprecation warning

    Use customerUserErrors instead