put https://{host}/api_gateway/core/v1/group/
This API allows you to update 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 .
Warning
If you update the group name,all the rewards linked to the group will be removed as the reward is linked based on the group name.
Prerequisites
- Authentication: Basic authentication
- Default access group
Resource information
| URI | /api_gateway/core/v1/group/{id} |
| HTTP method | PUT |
| Pagination | NA |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/core/v1/group/45
Request body parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| name* | String | The name of the group. |
| rank | Integer | The rank associated with the group. |
| isActive | Boolean | Set the isActive parameter to false to disable the group. Default: True |
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| id* | Integer | Unique identifier of the group. |
{
"name":"Group RankASDF",
"rank":2
}
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": 45,
"orgId": 51544,
"name": "Group RankASDF",
"rank": 2,
"isActive": true,
"createdBy": 50684454,
"createdOn": 1708509493000,
"lastUpdatedBy": 50684454,
"lastUpdatedOn": 1708510132420
}
API-specifc error
| Error code | Description |
|---|---|
| 400 | Group name must not be null |