v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Groups [Pilot]

Create a new group

Create a combo property or property variant (duplicates) to organize related listings with a designated primary listing. 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.

post/properties-api/groups/group

Request body

type'COMBO' | 'DUPLICATES' required

Type of the group

primarystring required

Primary listing ID

membersstring[] required

Array of listing IDs to be added to the group

Example request

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

Response

Group was successfully created

groupIdstring

type'COMBO' | 'DUPLICATES'

primarystring

membersstring[]

Example response

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