The Group entity is used to manage user groups in Deepser.
Groups can be only created by Administrators that can access the Group Module.
Agents and Key Users can only retrieve the Groups.
End Users cannot access this resource via API.
Endpoints
http://deepserhost/api/rest/group/[id]http://deepserhost/api/rest/groupshttp://deepserhost/api/rest/group/[id]/relation/usersRoles
Here we list all the permissions by user role regarding the API:
| Admininistrator | Agent | Key User | User | |
|---|---|---|---|---|
| Actions Allowed | RETRIEVE CREATE UPDATE * DELETE | RETRIEVE | RETRIEVE |
* UPDATE not allowed for endpoint:
http://deepdeskhost/api/rest/group/[id]/relation/usersFields
Here we list all the fields of the entity to describe their meainings in Deepser:
| Field | Meaning |
|---|---|
| entity_id | The unique ID to identify the record. |
| name | The name of the group displayed in the system. |
| description | Description of the group. |
| Email address of the group. | |
| level | Support level of the group |
| status | The status of the group. Typically 1 is Enabled, 0 is Disabled. |
| company_visibility | This is similar to company_visibility of the Users. This is a general setting used to set the visibility for all members of the group. |
| user_ids | An Array containing all the users of the group. |
| formtemplate_id | The form template ID used by the record. Please refer to the Formtemplate ID guide of Deepser Docs. |
| updated_at | Last update date of the record. |
| created_at | The creation date of the record. |
To get only the users in a group (without all the group information) you must use the GET method with the endpoint:
http://deepserhost/api/rest/group/[id]/relation/usersIt returns an array with the IDs of the users.
To add users in a group you must use the POST method with the endpoint:
http://deepserhost/api/rest/group/[id]/relation/usersJSON Payload Syntax: a JSON array with an array of the data to insert
[
[
21,
22
]
]
To delete users from a group you must use the DELETE method with the endpoint:
http://deepserhost/api/rest/group/[id]/relation/usersJSON Payload Syntax: a JSON array with an array of the data to delete
[
[
21,
22
]
]
