put
https://{host}/v2/userGroup2
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Example request
curl --location --request PUT 'https://eu.api.capillarytech.com/v2/userGroup2' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bWFkaH3MjU2YQ==' \
--data '{
"id": "3962909",
"externalId": "uat_ug_10_txn",
"groupName": "uatUserGroup10Transactions",
"maxGroupSize": 2
}'curl --location --request PUT 'https://eu.api.capillarytech.com/v2/userGroup2' \
--data '{
"id": "3918893",
"externalId": "uat_ug_10_txn",
"groupName": "uatUserGroup10Transactions",
"extendedFields": {
"usergroup2_automation_extended_field": "25"
}
}'Prerequisites
- Authentication: Basic or OAuth authentication
- Access group resource: Read and write access to the
User Groupresource
Resource information
| URI | /v2/userGroup2 |
| HTTP Method | PUT |
| Pagination | No |
| Batch support | No |
| Rate limit information | NA |
Request body parameters
| Query Parameter | Type | Mandatory | Description |
|---|---|---|---|
| id | integer | Yes | Unique ID of the user group, identical to the entity ID. |
| externalId | string | No | External ID of the group. |
| extendedFields | array | No | Array containing the extended fields and their corresponding values, enabled for specific verticals within the organization. Each extended field must be valid and created under the usergroup2 entity. |
| groupName | string | Yes | Name of the group. The maximum number of allowed characters is 50. |
| maxGroupSize | integer | No | Maximum size (members) of the group. The maximum group size is as defined by the product configuration CONF_MAX_FLEET_GROUP_SIZE. If this configuration is not set, the default maximum size is 30,000. |
Example response
{
"id": 3962909,
"externalId": "uat_ug_10_txn",
"groupName": "uatUserGroup10Transactions",
"maxGroupSize": 2,
"extendedFields": {},
"warnings": []
}{
"id": 3918893,
"externalId": "uat_ug_10_txn",
"groupName": "uatUserGroup10Transactions",
"maxGroupSize": 6,
"extendedFields": {
"ug_status": "Active",
"usergroup2_automation_extended_field": 25
},
"warnings": []
}Response parameters
| Parameter | Description |
|---|---|
| id | Unique identifier for the entity. |
| groupName | Name of the group being updated. |
| maxGroupSize | Maximum size (members) of the group. |
| extendedFields | An array containing the extended fields and their corresponding values, enabled for specific verticals within the organisation. |
| entityType | Type of entity. |
| promisedPointsScheduleList | This is an array containing objects of promised points scheduled for the user. |
| triggerBasedPointsList | This is an array containing objects of points based on specific triggers or conditions. |
| warnings | This is an array that contains warning messages, if any. |
API-specific error codes
| 1632 | Group ID, externalD, or primary userID is not valid |
| 91016 | This is a warning indicating the extended fields are incorrect. |
| 91017 | This is a warning indicating the extended fields are incorrect. |