isCompanyEmailAvailable query

Magento Commerce for B2B only

The content on this page is for Magento Commerce for B2B only. Learn more

The isCompanyEmailAvailable query checks whether the specified email is valid for company registration. The specified email can be the same as an existing customer or company administrator. If the email matches an existing company email, the query returns a false value.

Syntax

isCompanyEmailAvailable ( email String! ) IsCompanyEmailAvailableOutput

Example usage

The following example checks whether the email address roni_cost@example.com can be used to register a company.

Request:

1
2
3
4
5
query{
  isCompanyEmailAvailable(email: "roni_cost@example.com"){
    is_email_available
  }
}

Response:

1
2
3
4
5
6
7
{
  "data": {
    "isCompanyEmailAvailable": {
      "is_email_available": true
    }
  }
}

Input attribute

Attribute Data Type Description
email String! The email address to check

Output attribute

Attribute Data Type Description
is_email_available Boolean! A value of true indicates the email address is available