Contents

LocationGroupUpdate

The request body object for updating an existing location group.

Declaration

object LocationGroupUpdate

Properties

NameTypeDescription
namestring

Updated display name for the location group.

groupTypeLocationGroupType

Type of location grouping. Values: STATIC, DYNAMIC. Immutable after creation. To switch a group between types, delete the group and recreate it. See groupType Details in LocationGroupCreate.

rules[Rule]

Updated array of Rule objects for DYNAMIC groups. Replaces the existing rules and transitions systemStatus to PENDING. Wait for systemStatus: VALID before relying on the updated membership in active targeting.

locationIds[string]

Updated array of location IDs for STATIC groups. Replaces the existing list and may briefly set systemStatus to PENDING.

descriptionstring

Updated description of the location group.

Discussion

The LocationGroupUpdate object is the partial-update payload sent to Update Location Group. All fields are optional. The system changes only the fields you provide. Omitted fields retain their current values.

Example

{
  "name": "West Coast Stores (Updated)",
  "description": "All AwayFinder retail stores on the West Coast, including new Pacific Northwest locations"
}

See Also