Links

Register New Agent or Manager

Register a new agent or manager.
HTTP Method
URL
Requires Auth
POST
/api/v1/livechat/users/:type
yes

Path Variables

Key
Example Value
Description
type *
agent
The type of user that you want to register. The value can either be agent or manager.

Body

Key
Example Value
Description
username*
john.doe
The user name that you want to register.

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/users/agent' \
--header 'X-Auth-Token: Y97tM4GkYjgaH_fIO5dwBitQQvm3yp-AptYzGQZMX6e' \
--header 'X-User-Id: CkCPNcvsvCDfmWLqC' \
--header 'Content-Type: application/json' \
--data '{
"username": "john.doe"
}'

Example Response

{
"user": {
"_id": "SQafHvoFPuB57NmBD",
"username": "john.doe"
},
"success": true
}

Change Log

Version
Description
0.42.0
Added
Last modified 26d ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.