customerGenerateAccountActivationUrl

mutation

Requires write_customers access scope.

Generate an account activation URL for a customer.

Arguments

Anchor to customerIdcustomerId • ID!required: The ID of the customer that the URL is generated for.

Was this section helpful?

Anchor to CustomerGenerateAccountActivationUrlPayload returnsCustomerGenerateAccountActivationUrlPayload returns

Anchor to accountActivationUrlaccountActivationUrl • URL: The generated account activation URL.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Creates an account activation URL for a customer
customerGenerateAccountActivationUrl reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation customerGenerateAccountActivationUrl($customerId: ID!) {
6    customerGenerateAccountActivationUrl(customerId: $customerId) {
7      accountActivationUrl
8      userErrors {
9        field
10        message
11      }
12    }
13  }`,
14  {
15    variables: {
16      "customerId": "gid://shopify/Customer/105906728"
17    },
18  },
19);
20
21const data = await response.json();
22

mutation customerGenerateAccountActivationUrl($customerId: ID!) {
  customerGenerateAccountActivationUrl(customerId: $customerId) {
    accountActivationUrl
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation customerGenerateAccountActivationUrl($customerId: ID!) { customerGenerateAccountActivationUrl(customerId: $customerId) { accountActivationUrl userErrors { field message } } }",
 "variables": {
    "customerId": "gid://shopify/Customer/105906728"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation customerGenerateAccountActivationUrl($customerId: ID!) {
    customerGenerateAccountActivationUrl(customerId: $customerId) {
      accountActivationUrl
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "customerId": "gid://shopify/Customer/105906728"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerGenerateAccountActivationUrl($customerId: ID!) {
      customerGenerateAccountActivationUrl(customerId: $customerId) {
        accountActivationUrl
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "customerId": "gid://shopify/Customer/105906728"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation customerGenerateAccountActivationUrl($customerId: ID!) {
    customerGenerateAccountActivationUrl(customerId: $customerId) {
      accountActivationUrl
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "customerId": "gid://shopify/Customer/105906728"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "customerId": "gid://shopify/Customer/105906728"
3}

Response

JSON

1{
2  "customerGenerateAccountActivationUrl": {
3    "accountActivationUrl": "https://activation.example.com",
4    "userErrors": []
5  }
6}