This API allows you to create a group for the rewards.

👍
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call.

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/group/create' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVfjU2YQ==' \
--header 'Cookie: _cfuvid=EZk.XAGmnGytGPQFxLHCnFm_v4YhnMy7zloRQ46HJuo-1763640364440-0.0.1.1-604800000' \
--data '{
    "name":"UAT Group 7",
    "rank": 4
}'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	/api_gateway/rewards/core/v1/group/create
HTTP method	POST
Pagination	NA
Rate limit	NA
Batch support	NA

Request body parameters

Parameter Name	Data Type	Description
name*	String	The name of the group. The name of the group must be unique.
rank	Integer	The rank associated with the group. Group rank can be null.

Example response

{
    "id": 13272,
    "orgId": 100737,
    "name": "UAT Group 7",
    "rank": 4,
    "isActive": true,
    "createdBy": 75197372,
    "createdOn": 1763644650336,
    "createdOnDateTime": "2025-11-20T13:17:30Z",
    "lastUpdatedBy": 75197372,
    "lastUpdatedOn": 1763644650336,
    "lastUpdatedOnDateTime": "2025-11-20T13:17:30Z"
}

Response parameters

Parameter Name	Data Type	Description
id	Integer	The unique identifier of the group.
orgId	Integer	The organization identifier the group belongs to.
name	String	The name of the group.
rank	Integer	The numerical rank associated with the group.
isActive	Boolean	Indicates if the group is active.
createdBy	Integer	The identifier of the user who created the group.
createdOn	Long	Created on date and time of the field in Epoch time format.
createdOnDateTime	String	Creation date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
lastUpdatedBy	Integer	The identifier of the user who last updated the group.
lastUpdatedOn	Long	Last updated on date and time of the field in Epoch time format.
lastUpdatedOnDateTime	String	Last updated on date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

{
    "id": 2412,
    "orgId": 100737,
    "name": "groupName066",
    "rank": 8,
    "isActive": true,
    "createdBy": 75155282,
    "createdOn": 1742180327987,
    "createdOnDateTime": "2025-03-17T02:58:47Z",
    "lastUpdatedBy": 75155282,
    "lastUpdatedOn": 1742180327987,
    "lastUpdatedOnDateTime": "2025-03-17T02:58:47Z"
}

API-specific error

Error code	Description
400	Group name must not be null
12012	Group name must be unique