Anchor to section titled 'undefined'

customerActivateByUrl
mutation

Requires unauthenticated_write_customers access scope.

Activates a customer with the activation url received from customerCreate.

Anchor to section titled 'Arguments'

Arguments

Anchor to activationUrl
activationUrl
URL!
required

The customer activation URL.

Anchor to password
password
String!
required

A new password set during activation.

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

CustomerActivateByUrlPayload returns

Anchor to CustomerActivateByUrlPayload.customer
customer
Customer

The customer that was activated.

Anchor to CustomerActivateByUrlPayload.customerAccessToken
customerAccessToken
CustomerAccessToken

A new customer access token for the customer.

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

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerActivateByUrl($activationUrl: URL!, $password: String!) {
  customerActivateByUrl(activationUrl: $activationUrl, password: $password) {
    customer {
      # Customer fields
    }
    customerAccessToken {
      # CustomerAccessToken fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
  }
}
Hide code
Input
Copy
{
  "activationUrl": "https://example.myshopify.com",
  "password": "<your-password>"
}