Anchor to section titled 'undefined'customer
customer
mutation
Unstable
Requires write access scope.
Generate an account activation URL for a customer.
Anchor to section titled 'Arguments'
Arguments
The ID of the customer that the URL is generated for.
Was this section helpful?
Anchor to section titled 'CustomerGenerateAccountActivationUrlPayload returns'
CustomerGenerateAccountActivationUrlPayload returns
- Anchor to CustomerGenerateAccountActivationUrlPayload.accountActivationUrlaccount
Activation Url The generated account activation URL.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: customerGenerateAccountActivationUrl
Query Reference for MUTATION: customerGenerateAccountActivationUrl
"mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: customerGenerateAccountActivationUrl
"{\n \"customerId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: customerGenerateAccountActivationUrl
""
Display Examples for MUTATION: customerGenerateAccountActivationUrl
[
{
"example": {
"type_name": "customergenerateaccountactivationurl",
"title": "Generate a new account activation URL for a customer",
"query_string": "mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"customerId": "gid://shopify/Customer/105906728"
},
"response": {
"data": {
"customerGenerateAccountActivationUrl": {
"accountActivationUrl": "https://activation.example.com",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/customers/test/unit/graph_api/admin/mutations/customer_generate_account_activation_url_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerGenerateAccountActivationUrl($customerId: ID!) { customerGenerateAccountActivationUrl(customerId: $customerId) { accountActivationUrl userErrors { field message } } }\",\n \"variables\": {\n \"customerId\": \"gid://shopify/Customer/105906728\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"customerId\": \"gid://shopify/Customer/105906728\"\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"customerId\": \"gid://shopify/Customer/105906728\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"customerId\": \"gid://shopify/Customer/105906728\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation customerGenerateAccountActivationUrl($customerId: ID!) {\n customerGenerateAccountActivationUrl(customerId: $customerId) {\n accountActivationUrl\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"customerId\" => \"gid://shopify/Customer/105906728\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "customerId",
"description": "The ID of the customer that the URL is generated for.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "customerId",
"argValue": " \"gid://shopify/Customer/105906728\"",
"typeKind": "MUTATION"
}
]
}
]