Register New Agent or Manager

Prev Next
Post
/api/v1/livechat/users/{type}

Register a new agent or manager. Permission required: view-livechat-manager

Changelog

Version Description
0.42.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
type
stringRequired

The type of user that you want to register. The value can either be agent or manager.

Exampleagent
Body parameters
Example 1
{
  "username": "john.doe"
}
object
username
string Required

The user name that you want to register.

Responses
200

OK

Success Example
{
  "user": {
    "_id": "SQafHvoFPuB57NmBD",
    "username": "john.doe"
  },
  "success": true
}
Expand All
object
user
object
_id
string
username
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'username' [invalid-params]",
  "errorType": "invalid-params"
}
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
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string