Update Project Listing

HTTP Request

PATCHhttps://staging.api-gw.propdata.net/listings/api/v1/projects/{id}/

Example Response

{
"id": 0,
"site": 0,
"property_types": [],
"web_ref": "string",
"model": "string",
"area": 0,
"linked_residential": [],
"linked_commercial": [],
"created": "2021-03-01T14:10:09.359Z",
"modified": "2021-03-01T14:10:09.359Z",
"deleted": "2021-03-01T14:10:09.359Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"branch": -2147483648,
"agent": -2147483648,
"agent_2": -2147483648,
"agent_3": -2147483648,
"agent_4": -2147483648,
"poa": false,
"owner_viewing_arrangements": "string",
"location": -2147483648,
"is_custom_location": false,
"unit_number": "string",
"street_number": "string",
"street_name": "string",
"mapping_option": "string",
"complex_name": "string",
"publish_street_address": false,
"marketing_heading": "string",
"description": "string",
"map_image": -2147483648,
"map_x_position": "string",
"map_y_position": "string",
"team": -2147483648,
"display_on_website": false,
"feature_on_newsletter": false,
"feature_on_agent_newsletter": false,
"featured": false,
"header_images": [],
"listing_images": [],
"floor_plans": [],
"documents": [],
"private_documents": [],
"on_show": false,
"on_show_directions": "string",
"on_show_date": "string",
"on_show_every_saturday": false,
"on_show_every_sunday": false,
"on_show_start_time": "string",
"on_show_end_time": "string",
"status": "string",
"progress": "string",
"listing_type": "string",
"name": "string",
"property_type": "string",
"key_features": [],
"sole_mandate": false,
"mandate_start_date": "string",
"mandate_end_date": "string",
"mandate_reason_for_selling": "string",
"mandate_notes": "string",
"bond_bank": "string",
"bond_bank_branch": "string",
"bond_bank_account_number": "string",
"bond_bank_balance": "string",
"matterport_id": "string",
"video_id": "string",
"virtual_tour": "http://www.example.com",
"price": "0.00",
"land_size": "0.00",
"external_link_name": "string",
"external_link_url": "string",
"developer": "string",
"build_year": -2147483648,
"logo": -2147483648,
"progress_tracker": [],
"statistics": 0
}

NameDescription

id

required

integer

id of Record

NameDescription

id

integer

ID

site

integer

Site

property_types

array

Choices: [ 1,2,3...2147483648 ]

web_ref

stringnon-empty

Web ref

model

stringnon-empty

Model

area

integer

Area

linked_residential

array of integers

Choices: [ 1,2,3...2147483648 ]

linked_commercial

array of integers

Choices: [ 1,2,3...2147483648 ]

created

string

Created

modified

string

Modified

deleted

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

branch

required

integer

Branch - The Branch ID this listing is assigned to

agent

required

integer

Agent - The agent ID of the primary listing agent

agent_2

nullable

integer

Agent 2 - The agent ID of the second listing agent

agent_3

nullable

integer

Agent 3 - The agent ID of the third listing agent

agent_4

nullable

integer

Agent 4 - The agent ID of the fourth listing agent

poa

boolean

Poa - Whether the listing price is available on request

owner_viewing_arrangements

nullable

string

Owner viewing arrangements

location

required

integer

Location

is_custom_location

boolean

Is custom location

unit_number

nullable

string<= 10 characters

Unit number

street_number

nullable

string<= 10 characters

Street number

street_name

nullable

string<= 100 characters

Street name

mapping_option

nullable

string

Mapping option

Choices: AddressSuburb

complex_name

nullable

string<= 60 characters

Complex name

publish_street_address

boolean

Publish street address

marketing_heading

nullable

string<= 100 characters

Marketing heading

description

nullable

string

Description

map_image

nullable

integer

Map image

map_x_position

nullable

string<= 50 characters

Map x position

map_y_position

nullable

string<= 50 characters

Map y position

team

nullable

integer

Team

display_on_website

boolean

Display on website

feature_on_newsletter

boolean

Feature on newsletter

feature_on_agent_newsletter

boolean

Feature on agent newsletter

featured

boolean

Featured

header_images

nullable

array of integers

Header images

Choices: [ 1,2,3...2147483648 ]

listing_images

nullable

array of integers

Listing images

Choices: [ 1,2,3...2147483648 ]

floor_plans

nullable

array of integers

Floor plans

Choices: [ 1,2,3...2147483648 ]

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

private_documents

nullable

array of integers

Private documents

Choices: [ 1,2,3...2147483648 ]

on_show

boolean

On show

on_show_directions

nullable

string

On show directions

on_show_date

nullable

string

On show date

on_show_every_saturday

boolean

On show every saturday

on_show_every_sunday

boolean

On show every sunday

on_show_start_time

nullable

string

On show start time

on_show_end_time

nullable

string

On show end time

status

string

Status

Choices: ActiveArchived

progress

string

Progress

Choices: Off PlanIn ProgressCompleted

listing_type

required

string

Listing type

Choices: Residential EstateCommercial EstateResidential DevelopmentCommercial Development

name

required

string[ 1...100 ] characters

Name

property_type

string

Property type

Choices: Apartment BlockAffordable Housing DevelopmentCoastal EstateEquestrian EstateGame Farm EstateGolf EstateNature EstateResidential EstateRetirement EstateWine EstateLeasebackEco EstateBuildingBusiness ParkHotel InvestmentIndustrial DevelopmentIndustrial ParkMedical CentreMixed Use DevelopmentOffice DevelopmentOffice ParkRetail DevelopmentRetail ParkShopping Centre

key_features

nullable

array of strings

Key features

Choices: [ 1,2,3...2147483648 ]

sole_mandate

boolean

Sole mandate

mandate_start_date

nullable

string

Mandate start date

mandate_end_date

nullable

string

Mandate end date

mandate_reason_for_selling

nullable

string

Mandate reason for selling

mandate_notes

nullable

string

Mandate notes

bond_bank

nullable

string<= 80 characters

Bond bank

bond_bank_branch

nullable

string<= 80 characters

Bond bank branch

bond_bank_account_number

nullable

string<= 80 characters

Bond bank account number

bond_bank_balance

nullable

string<= 30 characters

Bond bank balance

matterport_id

nullable

string<= 100 characters

Matterport id

video_id

nullable

string<= 30 characters

Video id

virtual_tour

nullable

string<= 150 characters

Virtual tour

price

nullable

string

Price

land_size

nullable

string

Land size

external_link_name

nullable

string<= 20 characters

External link name

external_link_url

nullable

string<= 200 characters

External link url

developer

nullable

string<= 50 characters

Developer

build_year

nullable

integer

Build year

logo

nullable

integer

Logo

progress_tracker

nullable

array of integers

Progress tracker

Choices: [ 1,2,3...2147483648 ]

statistics

nullable

integer

Statistics

Responses

200
400 Bad request body
403 You do not have permission to perform this action
404 Not found
500 Internal server error
503 This website is not active