Groups

Edit a group

Modify the representation of a group by changing only the specified attributes. Unspecified attributes are left untouched. Note: Editing a dynamic group is not possible from the API.

patch/groups/{id}

Request

Base URL
https://api.cyberimpact.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cyberimpact/apis/cyberimpact-api/docs/groups/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The group's numerical ID

Request body

titlestring

The name of the group

isPublicboolean

Should the group be a public group or not. See our documentation for the difference between the two types: https://support.cyberimpact.com/articles/63?l=en_ca#publicvsprivategroup

Example request

{
  "title": "testing title Modification for group",
  "isPublic": true
}

Response

The modified group

idinteger

titlestring

isPublicboolean

membersCountinteger

mailingsCountinteger

createdOnstring

isDynamicboolean

Example response

{
  "id": 159872,
  "title": "Testing Group 1",
  "membersCount": 12,
  "createdOn": "2014-12-09 13:48:44.887"
}

Changes

No recorded changes to this operation across all 1 revision of this API.