latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Groups

Replace a group

Modify the representation of a group so that it becomes completely as specified. Unspecified attributes will be reset to their default empty values. Note: Replacing a dynamic group is not possible from the API.

put/groups/{id}

Path parameters

idinteger required

The group's numerical ID

Request body

titlestring required

The name of the group

isPublicboolean required

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 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"
}