Register User

HTTP MethodURLRequires Auth

POST

/api/v1/users.register

no

Body Parameters

KeyExample ValueDescription

username*

rogersmith

The username for the user.

email*

roger@example.com

The email for the user.

pass*

passw0rd

The password for the user.

name*

Roger Smith

The name of the user. The value can be an empty string "" if Require Name For Signup is disabled in Accounts > Registration

secret

Jjwjg6gouWLXhMGKW

String appended to secret registration URL.

Example Call

curl -H "Content-type:application/json" \
     http://localhost:3000/api/v1/users.register \
     -d '{ 
          "username": "rogersmith", 
          "email": "roger@example.com", 
          "pass": "passw0rd", 
          "name": "Roger Smith"}'

Example Response

{
  "user": {
    "_id": "nSYqWzZ4GsKTX4dyK",
    "type": "user",
    "status": "offline",
    "active": true,
    "name": "Example User",
    "utcOffset": 0,
    "username": "example"
  },
  "success": true
}

Change Log

VersionDescription

0.50.0

Added

Last updated

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