Update User Group

Lets you update an existing user group details.

❗️

Make sure you have the appropriate access control configured. For more information, see access group documentation.

API endpoint

https://{host}/v2/userGroup2

Query parameters

Query ParameterDescription
idUnique ID of the user group.
externalIdExternal ID of the group.
groupNameName of the group.
maxGroupSizeMaximum size (members) of the group.

Response parameters

ParameterDescription
entityIdThe unique identifier for the entity.
entityTypeThe type of entity.
promisedPointsScheduleListThis is an array contain objects of promised points scheduled for the user.
triggerBasedPointsListThis is an array contain objects of points based on specific triggers or conditions.
warningsThis is an array that contains warning messages, if any.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!