v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Groups [Pilot]

Update group

Modify a combo property or property variant (group) by adding or removing members, or changing the primary listing. Provide the complete list of members after the update. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants).

Check out our Help Center to learn more about these property types.

patch/properties-api/groups/group/{id}

Path parameters

idstring required

Example:63baba9c5c25ccae55958321

The ID of the group

Request body

primarystring

Primary listing ID (optional - only required when changing primary)

membersstring[] required

Array of listing IDs representing all members after update

Example request

{
  "primary": "63baba9c5c25ccae5595832b",
  "members": [
    "63baba9c5c25ccae5595832b",
    "63babaab5c25ccae5595832c"
  ]
}

Response

Group was successfully updated

groupIdstring

type'COMBO' | 'DUPLICATES'

primarystring

membersstring[]

Example response

{
  "groupId": "63baba9c5c25ccae55958321",
  "type": "COMBO",
  "primary": "63baba9c5c25ccae5595832b",
  "members": [
    "63baba9c5c25ccae5595832b",
    "63babaab5c25ccae5595832c"
  ]
}