put https://{host}/v2/userGroup2/members/permissions
API to update permissions of a member in a group.
This API enables you to update the user group permissions of a member in a group. There are four types of permissions that you can set for a member:
- allow_points_redemption
- allow_points_transfer
- block_points_redemption
- block_points_transfer
Note
For an overview on our APIs and for hands-on testing, refer to API overview and Make your first API call documentation.
Prerequisites
- Basic or OAuth credentials
- Access to Usergroup resource
Resource information
| URI | /v2/userGroup2/members/permissions |
| HTTP method | PUT |
| Pagination | NA |
| Rate limit | NA |
| Batch support | NA |
API endpoint example
https://eu.api.capillarytech.com/v2/userGroup2/members/permissions?id=3839
Request query parameters
| Parameter (Parameters marked * are mandatory) | Description |
|---|---|
| id* | User group identification number. |
Request body parameters
[{
"userId": 109983515,
"permissions":
["allow_points_transfer"]
}]
| Parameter (Parameters marked * are mandatory) | Type | Description |
|---|---|---|
| userId* | string | User ID (customer ID) of the group member you want to update the permission for. |
| permissions* | string | The permission list that you want to assign the user. Supported values: allow_points_redemption, allow_points_transfer, block_points_redemption, block_points_transfer |
Response parameters
{
"response": [
{
"entityId": {
"userId": 109983515,
"groupId": 3839,
"permissions": [
"allow_points_transfer"
],
"defaultGroup": false,
"primaryMember": false,
"active": false
},
"result": {
"userId": 109983515,
"groupId": 3839,
"permissions": [
"allow_points_transfer"
],
"defaultGroup": false,
"primaryMember": false,
"active": false
},
"warnings": []
}
],
"totalCount": 1,
"failureCount": 0
}
| Parameter | Description |
|---|---|
| response | An array containing the details of the response for each entity. |
| entityId | An object holding identifier and status details of the member in a user group. |
| - userId | Customer ID of the user group member. |
| - groupId | Identifier for the group to which the user belongs |
| - permissions | Array of permissions assigned to the user |
| - defaultGroup | Boolean indicating if this group is the user's default. |
| - primaryMember | Boolean indicating if the user is a primary member of the group. |
| - active | Boolean indicating if the user is active in this group. |
| result | Object echoing the relevant details of the entity, confirming the information processed. |
| warnings | Array for potential warning messages. |
| totalCount | Total number of entities processed |
| failureCount | Total number of entities that failed to process |
Error codes
| Error code | Description |
|---|---|
| 1632 | Invalid user group member ID passed. Make sure that the user group ID is valid. |