Send 2FA Email Code

Prev Next
Post
/api/v1/users.2fa.sendEmailCode
Header parameters
X-Auth-Token
string

The authToken of the authenticated user.

X-User-Id
string

The userId of the authenticated user.

Body parameters
Example 1
{
  "emailOrUsername": "[email protected]"
}
object
emailOrUsername
string Required

Enter the email or username.

Example[email protected]
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "emailOrUsername is required [error-parameter-required]",
  "errorType": "error-parameter-required"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string