Contact Groups

Contact group management endpoints

Create contact group

post

Create a new contact group in the organisation

Authorizations
Path parameters
unique_idstringRequired
Responses
201Success
application/json
post
/api/v1.0/organisation/{unique_id}/contact-groups/create/
POST /api/v1.0/organisation/{unique_id}/contact-groups/create/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "is_active": true,
  "created_by_name": "text",
  "date_created": "2025-10-25T20:11:49.043Z",
  "last_updated": "2025-10-25T20:11:49.043Z"
}

List contact groups

get

Get all contact groups for an organisation

Authorizations
Path parameters
unique_idstringRequired
Responses
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/
GET /api/v1.0/organisation/{unique_id}/contact-groups/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*
200Success
[
  {
    "unique_id": "text",
    "translations": "text",
    "is_active": true,
    "created_by_name": "text",
    "date_created": "2025-10-25T20:11:49.043Z",
    "last_updated": "2025-10-25T20:11:49.043Z"
  }
]

Contact group details

get

Get, update, or delete a specific contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/
GET /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "is_active": true,
  "contacts_count": "text",
  "date_created": "2025-10-25T20:11:49.043Z",
  "last_updated": "2025-10-25T20:11:49.043Z"
}

Contact group details

put

Get, update, or delete a specific contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/
PUT /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "is_active": true,
  "contacts_count": "text",
  "date_created": "2025-10-25T20:11:49.043Z",
  "last_updated": "2025-10-25T20:11:49.043Z"
}

Contact group details

delete

Get, update, or delete a specific contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/
DELETE /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "is_active": true,
  "contacts_count": "text",
  "date_created": "2025-10-25T20:11:49.043Z",
  "last_updated": "2025-10-25T20:11:49.043Z"
}

Contact group details

patch

Get, update, or delete a specific contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/
PATCH /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "is_active": true,
  "contacts_count": "text",
  "date_created": "2025-10-25T20:11:49.043Z",
  "last_updated": "2025-10-25T20:11:49.043Z"
}
PreviousOrganisation ManagementNextContacts