PropertyPixel Docs

Create a project

POST
/projects

Create a new, empty project for one property listing. Name it after the address or listing so the user can find it later. Then add photos with add_photos or create_upload_link.

Requires a connection with edit access.

Authorization

headerAuthorizationBearer <token>

An API key from Settings → Developers (pp_live_…), or an OAuth access token.

Header Parameters

Idempotency-Key?string

A unique key (for example a UUID) that makes retries safe. A retry with the same key and body returns the stored response; the same key with a different body returns 422. Keys last 24 hours.

Lengthlength <= 255

Request Body

application/json
  1. body
name*string

Project name, e.g. the street address.

Length1 <= length <= 200
address?string

Property address.

Lengthlength <= 500
property_type?string

Kind of property.

Value in"house""apartment""condo""townhouse""villa""land""commercial""office""retail""industrial""other"

Response Body

Create a project

application/json
  1. response
object*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
address*string|null
property_type*string|null
photo_count*integer
completed_job_count*integer
cover*|null
studio_url*string

Open this project in the PropertyPixel Studio.

Formaturi
created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
updated_at*|null
curl -X POST "https://example.com/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "object": "project",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "address": "string",  "property_type": "string",  "photo_count": 0,  "completed_job_count": 0,  "cover": {    "url": "http://example.com",    "expires_at": "2019-08-24T14:15:22Z"  },  "studio_url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}