customerGenerateAccountActivationUrl mutation

Generates a new account activation URL.

Required access

write_customers access scope.

On this page

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.

mutation customerGenerateAccountActivationUrl($customerId: ID!) { customerGenerateAccountActivationUrl(customerId: $customerId) { 
  1. <font style="color:#1F61A0;">accountActivationUrl</font>
  3. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  5.   <font style="color:#1F61A0;">field</font>
  7.   <font style="color:#1F61A0;">message</font>
  9. <font style="color:#555555;">}</font>
} } { “customerId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
customerId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the customer that the URL is generated for.

Return fields

  • accountActivationUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The newly generated account activation URL.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.