post https://{host}/v2/userGroup2
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
| Parameter | Type | Description |
|---|---|---|
| externalId | string | External ID of the group. |
| groupName | string | Name of the group. |
| maxGroupSize | integer | Maximum size (members) of the group. |
| limit | integer | The maximum number of items to be retrieved. |
Response parameters
| Parameter | Description |
|---|---|
| entity | This is the main data of the response. |
| warnings | This is an array that contains warning messages, if any. |