Skip to main content

Create Property Group

Write

Creates a property group in AppFolio®. To retrieve and query existing property groups, use the Property Groups endpoint.

The PropertyGroup Object​

This object is returned from the create a property group endpoint.

Attributes

appfolioIdstring
Unique ID of the created property group.
Example:
"8"
namestring
Name of the created property group.
Example:
"Sample Property Group"
propertyUuidsstring[]
Uuids of the properties belonging to this property group. Note these are AppFolio's stable property uuids, not the numeric AppFolio ids used in the request's propertyIds parameter — to list a group's members by numeric id, use the Property Groups endpoint.
Example:
["a1b2c3d4-0001-0001-0001-000000000001","a1b2c3d4-0001-0001-0001-000000000002","a1b2c3d4-0001-0001-0001-000000000003"]
uuidstring
Unique identifier of the property group in AppFolio.
Example:
"a1b2c3d4-0002-0002-0002-000000000001"
editableboolean
Whether the property group can be edited from your AppFolio account.
Example:
true
propertyCountinteger
Number of properties in the group.
Example:
3
The PropertyGroup Object
{
  "appfolioId": "8",
  "name": "Sample Property Group",
  "propertyUuids": [
    "a1b2c3d4-0001-0001-0001-000000000001",
    "a1b2c3d4-0001-0001-0001-000000000002",
    "a1b2c3d4-0001-0001-0001-000000000003"
  ],
  "uuid": "a1b2c3d4-0002-0002-0002-000000000001",
  "editable": true,
  "propertyCount": 3
}

Create a Property Group​

POST /v1/property-groups

Follows: Authentication • Caching • Polling • List Response Format

Creates a new property group.

Parameters​

namestring
Name of the property group to create.
propertyIdsmulti
AppFolio IDs of the properties to include in the group. Optional; the group may be created empty and populated later. Each ID must be a property in your AppFolio account.
 

Returns​

The standard List Response Format with a data property containing an array with the created PropertyGroup object.

The response reflects the property group as stored in AppFolio, not the request as submitted.

POST /v1/property-groups
curl -X POST 'https://api.skywalkapi.com/v1/property-groups' \ 
  -H "X-API-Key: PUT_YOUR_API_KEY_HERE" \ 
  -H "Content-Type: application/json" \ 
  -d '{"name":"Sample Property Group","propertyIds":["2","5","7"]}'
Response
{
  "meta": {
    "status": "ok",
    "path": "/v1/property-groups",
    "query": {
      "name": "Sample Property Group"
    },
    "count": 1,
    "lastUpdated": 1610992228
  },
  "errors": [],
  "data": [
    {
      "appfolioId": "8",
      "name": "Sample Property Group",
      "propertyUuids": [
        "a1b2c3d4-0001-0001-0001-000000000001",
        "a1b2c3d4-0001-0001-0001-000000000002",
        "a1b2c3d4-0001-0001-0001-000000000003"
      ],
      "uuid": "a1b2c3d4-0002-0002-0002-000000000001",
      "editable": true,
      "propertyCount": 3
    }
  ]
}