Post
/api/v1/users.verifyEmail
Verifies a user's email address using the token embedded in the verification sent to thier email. If the user has the anonymous role, it is replaced with the user role as part of the verification.
Changelog
| Version | Description |
|---|---|
| 8.7.0 | Added |
Body parameters
Example
{
"token": "hf5Wf4Kj9R3mR7cQ2xkPd"
}object
token
string Required
The email verification token the user received by email.
Examplehf5Wf4Kj9R3mR7cQ2xkPd
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Missing token
{
"success": false,
"error": "must have required property 'token' [invalid-params]",
"errorType": "invalid-params"
}Verification link expired
{
"success": false,
"error": "Verify email link expired"
}object
success
boolean
error
string
errorType
string