companyValidateEmail | BigCommerce Developer Center

query ExampleQuery($storeHash: String, $email: String, $role: Int, $channelId: Int) {
  companyValidateEmail(storeHash: $storeHash, email: $email, role: $role, channelId: $channelId) {
    isValid
    userInfo {
      id
      firstName
      lastName
      phoneNumber
      role
      companyRoleId
      companyRoleName
      email
      forcePasswordReset
    }
  }
}

{
  "storeHash": "example",
  "email": "example",
  "role": 0,
  "channelId": 0
}

{
  "data": {
    "companyValidateEmail": {
      "isValid": true,
      "userInfo": {
        "id": 0,
        "firstName": "example",
        "lastName": "example",
        "phoneNumber": "example",
        "role": 0,
        "companyRoleId": 0,
        "companyRoleName": "example",
        "email": "example",
        "forcePasswordReset": true
      }
    }
  }
}

Check if a user email can be used for the current company. Doesn't require a Token.

Arguments

storeHashStringRequired

The Store Hash. This field is required.

emailStringRequired

Email address of the user. This field is required.

roleIntegerRequired

The user role.
(0-Admin, 1-Senior Buyer, 2-Junior Buyer, 3-Sales Rep).
This field is required.

channelIdIntegerOptional

Store Channel ID

Returns

an optional Object

isValidBoolean

Is valid of this email

userInfoObject