Skip to main content
POST
Create a property import job

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

project_id
string<uuid>
required

Body

Input serializer for creating a property import job.

url
string<uri>
required

Public Zillow, Rightmove, Realtor, or Zoopla property URL.

Maximum string length: 1024

Response

Serializer for property import job status polling.

id
string<uuid>
required
read-only
provider
enum<string>
required
  • zillow - Zillow
  • rightmove - Rightmove
  • realtor - Realtor
  • zoopla - Zoopla
Available options:
zillow,
rightmove,
realtor,
zoopla
project_real_estate_id
string<uuid>
required
read-only

Target project for this import job.

external_url
string<uri>
required
read-only

Source listing URL.

status
enum<string>
required

Current job status.

  • queued - Queued
  • processing - Processing
  • expired - Expired
  • cancelled - Cancelled
  • completed - Completed
  • failed - Failed
Available options:
queued,
processing,
expired,
cancelled,
completed,
failed
total_image_count
integer
required
read-only
queued_image_count
integer
required
read-only
completed_image_count
integer
required
read-only
failed_image_count
integer
required
read-only
finished_image_count
integer
required
read-only

Sum of completed and failed image imports.

pending_image_count
integer
required
read-only

Queued image imports that have not reached a final state.

progress_percent
number<double>
required
read-only

Image import progress from 0 to 100.

is_finished
boolean
required
read-only

Whether the import job has reached a final state.

has_failures
boolean
required
read-only

Whether at least one image import failed.

error_message
string
required
read-only

Error details if job failed.

created_at
string<date-time>
required
read-only

Datetime when the record was created.

updated_at
string<date-time>
required
read-only

Datetime when the record was last updated.