Send 2FA Email Code

HTTP MethodURLRequires Auth

POST

/api/v1/users.2fa.sendEmailCode

Body Parameters

KeyExample ValueDescription

email or username

test@email.com

Enter the email or username.

Example Call

curl  -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
      -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
      -H "Content-type: application/json" \
      'http://localhost:3000/api/v1/users.2fa.sendEmailCode\
      -d "emailOrUsername=email@rocket.chat"

Example Response

Success

{
    "success": true
}

Errors

The following error can occur.

  • Valid Email or Username: Requires selector param for the request to be made.

{
    "success": false,
    "error": "emailOrUsername is required [error-parameter-required]",
    "errorType": "error-parameter-required"
}

Last updated

Rocket.Chat versions receive support for six months after release.