--- title: customerSendAccountInviteEmail - GraphQL Admin description: Sends the customer an account invite email. api_version: 2025-10 api_name: admin type: mutation api_type: graphql source_url: html: https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSendAccountInviteEmail?example=sends-an-account-invite-to-a-customer md: https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSendAccountInviteEmail.md?example=sends-an-account-invite-to-a-customer --- # customer​Send​Account​Invite​Email mutation Requires `write_customers` access scope. Also: The user must have permission to create and edit customers. Sends the customer an account invite email. ## Arguments * customer​Id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required The ID of the customer to whom an account invite email is to be sent. * email [Email​Input](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/EmailInput) Specifies the account invite email fields. *** ## Customer​Send​Account​Invite​Email​Payload returns * customer [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) The customer to whom an account invite email was sent. * user​Errors [\[Customer​Send​Account​Invite​Email​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerSendAccountInviteEmailUserError) non-null The list of errors that occurred from executing the mutation. *** ## Examples * ### Sends an account invite to a customer #### Query ```graphql mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } } ``` #### Variables ```json { "customerId": "gid://shopify/Customer/105906728" } ``` #### cURL ```bash curl -X POST \ https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }", "variables": { "customerId": "gid://shopify/Customer/105906728" } }' ``` #### React Router ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }`, { variables: { "customerId": "gid://shopify/Customer/105906728" }, }, ); const json = await response.json(); return json.data; } ``` #### Ruby ```ruby 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 CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } } QUERY variables = { "customerId": "gid://shopify/Customer/105906728" } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }`, "variables": { "customerId": "gid://shopify/Customer/105906728" }, }, }); ``` #### Response ```json { "customerSendAccountInviteEmail": { "customer": { "id": "gid://shopify/Customer/105906728" }, "userErrors": [] } } ``` * ### customerSendAccountInviteEmail reference [Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20CustomerSendAccountInviteEmail\(%24customerId%3A%20ID!\)%20%7B%0A%20%20customerSendAccountInviteEmail\(customerId%3A%20%24customerId\)%20%7B%0A%20%20%20%20customer%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%7D%0A%20%20%20%20userErrors%20%7B%0A%20%20%20%20%20%20field%0A%20%20%20%20%20%20message%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22customerId%22%3A%20%22gid%3A%2F%2Fshopify%2FCustomer%2F105906728%22%0A%7D) ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }`, { variables: { "customerId": "gid://shopify/Customer/105906728" }, }, ); const json = await response.json(); return json.data; } ``` ##### GQL ``` mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } } ``` ##### cURL ``` curl -X POST \ https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }", "variables": { "customerId": "gid://shopify/Customer/105906728" } }' ``` ##### React Router ``` import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }`, { variables: { "customerId": "gid://shopify/Customer/105906728" }, }, ); const json = await response.json(); return json.data; } ``` ##### Node.js ``` const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } }`, "variables": { "customerId": "gid://shopify/Customer/105906728" }, }, }); ``` ##### Ruby ``` 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 CustomerSendAccountInviteEmail($customerId: ID!) { customerSendAccountInviteEmail(customerId: $customerId) { customer { id } userErrors { field message } } } QUERY variables = { "customerId": "gid://shopify/Customer/105906728" } response = client.query(query: query, variables: variables) ``` ## Input variables JSON ```json { "customerId": "gid://shopify/Customer/105906728" } ``` ## Response JSON ```json { "customerSendAccountInviteEmail": { "customer": { "id": "gid://shopify/Customer/105906728" }, "userErrors": [] } } ```