Register New Department
- Print
- DarkLight
- PDF
Register New Department
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/livechat/department
Permission required: manage-livechat-departments
Changelog
| Version | Description |
|---|---|
| 1.0.0 | New fields for department updated |
| 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
Body parameters
Example 1
{
"department": {
"enabled": false,
"showOnRegistration": true,
"name": "new from api",
"email": "[email protected]",
"showOnOfflineForm": true
},
"agents": [
{
"agentId": "SQafHvoFPuB57NmBD"
}
]
}object
department
objectRequired
The object which takes the department details.
enabled
boolean Required
Whether you want to enable the department. The value can be boolean true or false.
showOnRegistration
boolean Required
You can let visitors choose the department they want to talk to. The option will appear to your customer in the Live Chat widget. The value can be boolean true or false.
name
string Required
The name of the department you are creating.
email
string Required
The email ID associated with the department.
showOnOfflineForm
boolean Required
If you want your department to be displayed during off-business hours. The value can be boolean true or false.
description
string
A description of your department.
agents
Array of object
The object with the agent details that you want to add to the department.
object
agentId
string
The agent ID that you want to assign to the department.
count
integer
The number of chats served by the agent. Enter a value if you want to reset the stored value. Note: This field is used by the routing algorithm to determine the agents that have served the least number of chats and assign new chats to them.
order
integer
The order in which the agents are assigned to chats.
Responses
200
OK
Success Example
{
"department": {
"enabled": false,
"name": "new from api",
"numAgents": 1,
"showOnRegistration": true,
"_updatedAt": "2016-12-13T17:22:19.109Z",
"_id": "iTfLCX3qqwKgf5uqg"
},
"agents": [
{
"agentId": "SQafHvoFPuB57NmBD",
"count": 0,
"order": 0
}
],
"success": true
}object
department
object
enabled
boolean
name
string
numAgents
integer
showOnRegistration
boolean
_updatedAt
string
_id
string
agents
Array of object
object
agentId
string
count
integer
order
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'department' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "must have required property 'name' [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
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?