Searching:
0 results foundUsers/ValidateEmail
POST /odata/users/validateEmail
Description
This option should be used before creating a new User using the Users/Post endpoint. This endpoint checks whether a User already exists in this specific application with this email address. If yes, then an additional User cannot be created. This endpoint also verifies whether the specified email address has valid email syntax.
See the following for request and response details ‒
See Also
Request ‒ Users/ValidateEmail
Property | Type | Description | Mandatory |
String | The Axonize User’s email address to be validated. | Y |
Example JSON Users/ValidateEmail Request
curl -X POST \
https://api.stg.axonize.com/odata/users/validateEmail \
-H ‘Cache-Control: no-cache’ \
-H ‘Content-Type: application/json’ \
-H ‘appId: be517433-c4b8-4748-9258-1b1234567890’ \
-H ‘Authorization: Token’ \
-d ‘{
“email”: “demouser@axonize.com”
}’
Response ‒ Users/ValidateEmail
All the same properties in the request are returned in the response.
Example JSON Users/ValidateEmail Response
Status 200 – OK
If the email does not exist and has valid email syntax, then the response is empty.
If the email exists, then the following error message is returned – Email already exists.
If the email does not have valid email syntax, then the following error message is returned – Email is not valid.