Anchor to section titled 'undefined'

customerSendAccountInviteEmail
mutation

Requires write_customers access scope.

Sends the customer an account invite email.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerId
customerId
ID!
required

The ID of the customer to whom an account invite email is to be sent.

Anchor to email
email
EmailInput

Specifies the account invite email fields.

Was this section helpful?
Anchor to section titled 'CustomerSendAccountInviteEmailPayload returns'

CustomerSendAccountInviteEmailPayload returns

Anchor to CustomerSendAccountInviteEmailPayload.customer
customer
Customer

The customer to whom an account invite email was sent.

Anchor to CustomerSendAccountInviteEmailPayload.userErrors
userErrors
[CustomerSendAccountInviteEmailUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerSendAccountInviteEmail($customerId: ID!) {
  customerSendAccountInviteEmail(customerId: $customerId) {
    customer {
      # Customer fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerId": "gid://shopify/<objectName>/10079785100",
  "email": {
    "bcc": [
      "<your-bcc>"
    ],
    "body": "<your-body>",
    "customMessage": "<your-customMessage>",
    "from": "<your-from>",
    "subject": "<your-subject>",
    "to": "<your-to>"
  }
}
input EmailInput {
  bcc: [String!]
  body: String
  customMessage: String
  from: String
  subject: String
  to: String
}