Add Group

Lets you create a new user group. Groups you create will be added to the default loyalty program of the org automatically.

📘

In response, entity is the unique ID of the group generated.

❗️

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

API endpoint

{host}/v2/userGroup2

Query parameters

ParameterTypeDescription
externalIdstringExternal ID of the group.
groupNamestringName of the group. The maximum allowed number of characters is 50.
maxGroupSizeintegerMaximum size (members) of the group.
limitintegerThe maximum number of items to be retrieved.

Response parameters

ParameterDescription
entityThis is the main data of the response.
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!