Anchor to section titled 'undefined'

customerActivate
mutation

Requires unauthenticated_write_customers access scope.

Activates a customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

Specifies the customer to activate.

Anchor to input
input
CustomerActivateInput!
required

The fields used to activate a customer.

Was this section helpful?
Anchor to section titled 'CustomerActivatePayload returns'

CustomerActivatePayload returns

Anchor to CustomerActivatePayload.customer
customer
Customer

The customer object.

Anchor to CustomerActivatePayload.customerAccessToken
customerAccessToken
CustomerAccessToken

A newly created customer access token object for the customer.

Anchor to CustomerActivatePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CustomerActivatePayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use customerUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerActivate($id: ID!, $input: CustomerActivateInput!) {
  customerActivate(id: $id, input: $input) {
    customer {
      # Customer fields
    }
    customerAccessToken {
      # CustomerAccessToken fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100",
  "input": {
    "activationToken": "<your-activationToken>",
    "password": "<your-password>"
  }
}
input CustomerActivateInput {
  activationToken: String!
  password: String!
}