Check Department Creation

Prev Next
Get
/api/v1/livechat/department/isDepartmentCreationAvailable

Use this endpoint to check whether departments can be created on the workspace. Workspaces on the Premium plans have no limit to the number of departments that can be created. On Community workspaces, only one department can be created.

Any of the following permissions is required:

  • view-livechat-departments
  • manage-livechat-departments
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Example 1
{
  "isDepartmentCreationAvailable": true,
  "success": true
}
If a department already exists in Community workspaces
{
  "isDepartmentCreationAvailable": false,
  "success": true
}
object
isDepartmentCreationAvailable
boolean
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string