customerSendAccountInviteEmail - admin-graphql - MUTATION

Version: 2024-10

Description:

Sends the customer an account invite email.

Access Scopes

`write_customers` access scope.

Arguments

• customerId: ID! - The ID of the customer to whom an account invite email is to be sent.
• email: EmailInput - Specifies the account invite email fields.

Returns

• customer: Customer The customer to whom an account invite email was sent.
• userErrors: CustomerSendAccountInviteEmailUserError! The list of errors that occurred from executing the mutation.

Examples

• Sends an account invite to a customer

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }\",\n \"variables\": {\n    \"customerId\": \"gid://shopify/Customer/105906728\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CustomerSendAccountInviteEmail($customerId: ID!) {\n      customerSendAccountInviteEmail(customerId: $customerId) {\n        customer {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"customerId\": \"gid://shopify/Customer/105906728\"\n    },\n  },\n});\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 CustomerSendAccountInviteEmail($customerId: ID!) {\n    customerSendAccountInviteEmail(customerId: $customerId) {\n      customer {\n        id\n      }\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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation CustomerSendAccountInviteEmail($customerId: ID!) {\n    customerSendAccountInviteEmail(customerId: $customerId) {\n      customer {\n        id\n      }\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"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation CustomerSendAccountInviteEmail($customerId: ID!) {\n    customerSendAccountInviteEmail(customerId: $customerId) {\n      customer {\n        id\n      }\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"
          Graphql query: "mutation CustomerSendAccountInviteEmail($customerId: ID!) {\n  customerSendAccountInviteEmail(customerId: $customerId) {\n    customer {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "customerId": "gid://shopify/Customer/105906728"
  }

  response: {
    "data": {
      "customerSendAccountInviteEmail": {
        "customer": {
          "id": "gid://shopify/Customer/105906728"
        },
        "userErrors": []
      }
    }
  }