isEmailAvailable query
The isEmailAvailable
query checks whether the specified email has already been used to create a customer account. A value of true
indicates the email address is available, and the customer can use the email address to create an account.
Syntax
{isEmailAvailable (email): {IsEmailAvailableOutput}}
Example usage
The following example checks whether the email address customer@example.com
is available to create a customer account.
Request:
1
2
3
4
5
{
isEmailAvailable(email: "customer@example.com") {
is_email_available
}
}
Response:
1
2
3
4
5
6
7
{
"data": {
"isEmailAvailable": {
"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, and the customer can use the email address to create an account |