Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Groups

Create a new group

Creates a new group. Provide the necessary details as per the group type.

post/groups

Request body

namestring required

The group's name.

type'general' | 'administrators' | 'end-users' required

The group type.

supportLevelinteger

A number representing the support level (from existing support levels).

companyIdinteger nullable

The unique identifier for the company associated with the group.

emailstring email

The email address associated with the group.

receiveAutomaticSrEmailNotificationsboolean

Indicates whether the group receives automatic SR email notifications.

canBeAssignedToServiceRecordboolean

Indicates if the group can be assigned to a service record. Not applicable if type is set to END_USERS.

enableAutomaticDispatchOfServiceRecordsboolean

Determines if service records should be automatically dispatched. Only applicable if canBeAssignedToServiceRecord is true

Example request

{
  "name": "IT Support",
  "supportLevel": 3,
  "companyId": 1001,
  "email": "support@example.com",
  "receiveAutomaticSrEmailNotifications": true,
  "canBeAssignedToServiceRecord": true
}

Response

Group created successfully

namestring required

The group's name.

type'general' | 'administrators' | 'end-users' required

The group type.

supportLevelinteger

A number representing the support level (from existing support levels).

companyIdinteger nullable

The unique identifier for the company associated with the group.

emailstring email

The email address associated with the group.

receiveAutomaticSrEmailNotificationsboolean

Indicates whether the group receives automatic SR email notifications.

canBeAssignedToServiceRecordboolean

Indicates if the group can be assigned to a service record. Not applicable if type is set to END_USERS.

enableAutomaticDispatchOfServiceRecordsboolean

Determines if service records should be automatically dispatched. Only applicable if canBeAssignedToServiceRecord is true

idinteger required

The unique identifier of the group.

Example response

{
  "name": "IT Support",
  "supportLevel": 3,
  "companyId": 1001,
  "email": "support@example.com",
  "receiveAutomaticSrEmailNotifications": true,
  "canBeAssignedToServiceRecord": true,
  "id": 123
}