post https://{host}/api_gateway/core/v1/group/create
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 .
Prerequisites
- Authentication: Basic authentication
- Default access group
Resource information
| URI | /api_gateway/core/v1/group/create |
| HTTP method | POST |
| Pagination | NA |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/core/v1/group/create
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. |
{
"name":"GROUP_withRANK123",
"rank":99
}
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 | The timestamp when the group was created. |
| lastUpdatedBy | Integer | The identifier of the user who last updated the group. |
| lastUpdatedOn | Long | The timestamp when the group was last updated. |
{
"id": 42,
"orgId": 51544,
"name": "Group Ranking",
"rank": 1,
"isActive": true,
"createdBy": 50684454,
"createdOn": 1708500949361,
"lastUpdatedBy": 50684454,
"lastUpdatedOn": 1708500949361
}
API-specific error
| Error code | Description |
|---|---|
| 400 | Group name must not be null |
| 12012 | Group name must be unique |