customerRecover mutation

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead

Sends a reset password email to the customer, as the first step in the reset password process.

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
email ( String! ) required

The email address of the customer to recover.

Return fields

  • customerUserErrors ([CustomerUserError!]!)

    The list of errors that occurred from executing the mutation.

Deprecated return fields

  • userErrors ([UserError!]!) deprecated

    The list of errors that occurred from executing the mutation.

    Deprecation warning

    Use customerUserErrors instead