Groups
Posted on Mar 04, 2016 16:57
With this API call you can manage your Groups.
JSON Format
Each Group is represented as JSON object with the following properties:
| Name |
Type |
Description |
| Id |
number |
The group's id |
| Name |
string |
The group's name |
| Description |
string |
The group's description |
| Enabled |
boolean |
Shows whether the group is enabled |
| Members |
array |
List with agent IDs which are members of the group |
Get All Groups
GET /api/groups
Get all groups for your account.
Example response
|
[
{
"Id": 5,
"Name": "Sales",
"Description": "Sales department",
"Enabled": true,
"Members": [
150,
151
]
},
{
"Id": 6,
"Name": "Finance",
"Description": "",
"Enabled": true,
"Members": [
150,
152
]
}
]
|
Get Group by Id
GET /api/groups/{group_id}
Get a group from your account by specified id.
Example response
|
{
"Id": 5,
"Name": "Sales",
"Description": "Sales department",
"Enabled": true,
"Members": [
150,
151
]
}
|
Create Group
POST /api/groups
Create a group for your account.
Example response
|
{
"Id": 7,
"Name": "Support",
"Description": null,
"Enabled": true,
"Members": [
150
]
}
|
Update Group
PUT /api/groups/{group_id}
Update a group from your account by specified id.
Example response
|
{
"Id": 5,
"Name": "Sales",
"Description": "Sales department,
"Enabled": true,
"Members": [
150
]
}
|
Delete Group
DELETE /api/groups/{group_id}
Delete a group from your account by specified id.