API reference

Property pictures

Resource propertyPictures

Properly fetches each picture from a URL you host and stores its own copy.

Name the property with either propertyId or sourcePropertyId. The legacy pictureUrl field on the property itself is a picture identifier, not a URL; prefer these endpoints.

Add a property picture

POST /v1/propertyPictures 201 Created x-api-key

Properly downloads the image at sourceUrl, stores it, and attaches it to the property. Returns the created picture with its pictureId.

Request body
Field	Type	Required	Notes
`sourceId`	`string`	Required	Your identifier for the picture.
`sourceUrl`	`string`	Required	Publicly fetchable image URL.
`propertyId`	`string`	One of	One of propertyId or sourcePropertyId identifies the property.
`sourcePropertyId`	`string`	One of	Your property id.

Request

curl -X POST https://platform.getproperly.com/v1/propertyPictures \
  -H "x-api-key: $PROPERLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceId": "pms-pic-1",
    "sourceUrl": "https://cdn.example.com/listings/100234/front.jpg",
    "sourcePropertyId": "pms-100234"
  }'

Remove a property picture

DELETE /v1/propertyPictures/{pictureId} 204 No Content x-api-key

Removes the picture from the property. Returns 204 with no body.

Request

curl -X DELETE https://platform.getproperly.com/v1/propertyPictures/pic_4Kd8 \
  -H "x-api-key: $PROPERLY_API_KEY"