Contact Groups

Contact group management endpoints

Create contact group

post

Create a new contact group in the organisation

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

unique_idstringRequired

Responses

201Success

application/json

400Error

application/json

401Error

application/json

post

/api/v1.0/organisation/{unique_id}/contact-groups/create/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
  "last_updated": "2025-12-11T11:03:15.804Z"
}

List contact groups

get

Get all contact groups for an organisation

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

unique_idstringRequired

Responses

200Success

application/json

get

/api/v1.0/organisation/{unique_id}/contact-groups/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
    "last_updated": "2025-12-11T11:03:15.804Z"
  }
]

Contact group details

get

Get, update, or delete a specific contact group

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

group_unique_idstringRequired

unique_idstringRequired

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

get

/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
  "last_updated": "2025-12-11T11:03:15.804Z"
}

Contact group details

put

Get, update, or delete a specific contact group

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

group_unique_idstringRequired

unique_idstringRequired

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

put

/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
  "last_updated": "2025-12-11T11:03:15.804Z"
}

Contact group details

delete

Get, update, or delete a specific contact group

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

group_unique_idstringRequired

unique_idstringRequired

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

delete

/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
  "last_updated": "2025-12-11T11:03:15.804Z"
}

Contact group details

patch

Get, update, or delete a specific contact group

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

group_unique_idstringRequired

unique_idstringRequired

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

patch

/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/

HTTPcURLJavaScriptPython

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-12-11T11:03:15.804Z",
  "last_updated": "2025-12-11T11:03:15.804Z"
}