Update Profile

HTTP Request

PATCHhttps://staging.api-gw.propdata.net/contacts/api/v1/profiles/{id}/

Example Response

{
"id": 0,
"tags": [],
"site": 0,
"contact": 0,
"lead": "string",
"source": "string",
"statistics": 0,
"meta": {},
"created": "2024-03-28T13:31:11.467Z",
"modified": "2024-03-28T13:31:11.467Z",
"deleted": "2024-03-28T13:31:11.467Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"status": "string",
"active": false,
"profile_type": "string",
"suburbs": [],
"areas": [],
"listing_model": "string",
"zoning": "string",
"receive_email_marketing": false,
"property_types": [],
"price_from": "0.00",
"price_to": "0.00",
"floor_size_from": "0.00",
"floor_size_to": "0.00",
"erf_size_from": "0.00",
"erf_size_to": "0.00",
"bedrooms": "0.00",
"bathrooms": "0.00",
"garages": "0.00",
"carports": "0.00",
"agent": 0
}

NameDescription

id

required

integer

id of Record

NameDescription

id

integer

ID

tags

nullable

array of strings

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

site

integer

Site

contact

required

integer

Contact

lead

string

Lead

source

stringnon-empty

Source

statistics

integer

Statistics

meta

string

Meta

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

status

nullable

string

Status

Choices: ActiveInactiveNon-CompliantNo-Consent

active

boolean

Active

profile_type

required

string

Profile type

Choices: BuyerTenant

suburbs

nullable

array of integers

Suburbs

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

areas

nullable

array of integers

Areas

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

listing_model

required

string

Listing model

Choices: residentialcommercialholidayproject

zoning

nullable

string

Zoning

Choices: AgriculturalCommercialIndustrialMixed UseRetail

receive_email_marketing

boolean

Receive email marketing

property_types

nullable

array of strings

Property types

Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreChaletClubClusterCo-working SpaceCompoundContractDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical CentreMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShopping CentreShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityUnitsVacant LandVillaWarehouseWorkshop

price_from

nullable

string

Price from

price_to

nullable

string

Price to

floor_size_from

nullable

string

Floor size from

floor_size_to

nullable

string

Floor size to

erf_size_from

nullable

string

Erf size from

erf_size_to

nullable

string

Erf size to

bedrooms

nullable

string

Bedrooms

bathrooms

nullable

string

Bathrooms

garages

nullable

string

Garages

carports

nullable

string

Carports

agent

nullable

integer

Agent

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