Recalculates membership for a single user-defined auto group
Use this endpoint to force a membership refresh for a specific user-defined auto group.
Only applicable to groups with userDefinedAutoGroup=true; non-auto groups will return an error.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| placeGroupId | Unique numeric identifier of the user-defined auto group to refresh | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
GroupPlaceGroupResponse
| Property | Description | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| autoGroup | Indicates if this place group is an autogroup | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||
| lastUpdated | The last time a member was inserted, updated, or deleted from the group | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| limitMembersByTopmost | Indicates if the place group has been set limit the list of members by the user’s topmost | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||
| memberCount | The number of places in this group | integer (int32) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| memberCountWithTopmost | The number of places within the currently authenticated user’s topmost | integer (int32) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| placeGroupCategory | PlaceGroupCategoryChild | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PlaceGroupCategoryChild properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
| placeGroupCode | The place group code | string | |||||||||||||||||||||||||||||||||||||||||||||||||||
| placeGroupId | The place group identifier | integer (int32) | |||||||||||||||||||||||||||||||||||||||||||||||||||
| placeGroupInfo | The place group info | string | |||||||||||||||||||||||||||||||||||||||||||||||||||
| userDefinedAutoGroup | Indicates if this place group is an user defined auto group | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||
| userDefinedAutoGroupFilters | The filters applied to determine the members of a user defined auto group | FilterResponse[] | |||||||||||||||||||||||||||||||||||||||||||||||||||
|
FilterResponse properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Example Response
{ "autoGroup": false, "lastUpdated": "2026-06-29", "limitMembersByTopmost": false, "memberCount": 1, "memberCountWithTopmost": 1, "placeGroupCategory": { "placeGroupCategoryCode": "string", "placeGroupCategoryId": 1, "placeGroupCategoryInfo": "string"
}, "placeGroupCode": "string", "placeGroupId": 1, "placeGroupInfo": "string", "userDefinedAutoGroup": false, "userDefinedAutoGroupFilters": [
{ "availableOperator": [
"string"
], "caption": "string", "dataFieldId": 1, "dataType": { "dataTypeCode": "string", "dataTypeId": 1, "dataTypeInfo": "string"
}, "fieldId": 1, "hidden": false, "operator": "string", "queryParameterName": "string", "recommended": false, "required": false, "value": "string"
}
]
}
400
Bad Request
The request was malformed or contains invalid parameters. Check the request body and query parameters.
404
Not Found
The requested resource was not found. Verify the ID or path is correct.