Projects

Create a project

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.

post/projects

Request

  • Base URL: https://api.propertypixel.app/v1
  • URL: https://api.propertypixel.app/v1/projects
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/authorize, token URL https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/token)

Headers

Idempotency-Keystring

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.

Request body

namestring required

Project name, e.g. the street address.

addressstring

Property address.

property_type'apartment' | 'villa' | 'townhouse' | 'penthouse' | 'office' | 'retail' | 'other'

Kind of property. Use villa for a detached house, apartment for a condo or flat, and other for anything else (land, industrial, mixed use).

Response

Create a project

object'project' required
idstring uuid required
namestring required
addressstring nullable required
property_typestring nullable required
photo_countinteger required
completed_job_countinteger required
studio_urlstring uri required

Open this project in the PropertyPixel Studio.

created_atstring date-time required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.