v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Group

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

post/userGroup2

Request body

externalIdstring required

External ID of the group.

groupNamestring

Name of the group. The maximum allowed number of characters is 50.

maxGroupSizeinteger required

Maximum size (members) of the group.

extendedFieldsstring[]

Array containing the extended fields and their values. Note: Extended fields are supported only for the usergroup2 entity.

Response

200

OR

Example response

{
  "entity": 2361
}