companyContactSendWelcomeEmail

mutation

Requires write_customers access scope or write_companies access scope. Also: The shop must have access to B2B. Some operations may require additional plan capabilities.

Sends the company contact a welcome email.

Anchor to Arguments

Arguments

Anchor to companyContactIdcompanyContactId

•ID!

required

The ID of the company contact to send welcome email to.

Anchor to emailemail

•EmailInput

The welcome email fields.

Was this section helpful?

Anchor to CompanyContactSendWelcomeEmailPayload returnsCompanyContactSendWelcomeEmailPayload returns

Anchor to companyContactcompanyContact •CompanyContact: The company contact to whom a welcome email was sent.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

companyContactSendWelcomeEmail reference

Mutation Reference

mutation companyContactSendWelcomeEmail($companyContactId: ID!, $email: EmailInput) {

companyContactSendWelcomeEmail(companyContactId: $companyContactId, email: $email) {

companyContact {

# CompanyContact fields

}

userErrors {

field

message

}

Input

{

"companyContactId": "gid://shopify/<objectName>/10079785100",

"email": {

"bcc": [

"<your-bcc>"

"body": "<your-body>",

"customMessage": "<your-customMessage>",

"from": "<your-from>",

"subject": "<your-subject>",

"to": "<your-to>"

}

Variables

{
  "companyContactId": "gid://shopify/<objectName>/10079785100",
  "email": {
    "bcc": [
      "<your-bcc>"
    ],
    "body": "<your-body>",
    "customMessage": "<your-customMessage>",
    "from": "<your-from>",
    "subject": "<your-subject>",
    "to": "<your-to>"
  }
}

Schema

input EmailInput {
  bcc: [String!]
  body: String
  customMessage: String
  from: String
  subject: String
  to: String
}