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

customerActivate mutation

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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

Activates a 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
id ( ID! ) required

Specifies the customer to activate.
input ( CustomerActivateInput! ) required

The fields used to activate a customer.

CustomerActivateInput fields

  • activationToken (String!) Required

    The activation token required to activate the customer.

  • password (String!) Required

    New password that will be set during activation.

Return fields

  • customer (Customer)

    The customer object.

  • customerAccessToken (CustomerAccessToken)

    A newly created customer access token object for the customer.

  • 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