Create Referral

HTTP Request

POSThttps://staging.api-gw.propdata.net/contacts/api/v1/referrals/

Example Response

{
  "id": 0,
  "tags": [],
  "site": 0,
  "direction": "string",
  "meta": {},
  "expiry_date": "string",
  "created": "2025-07-17T08:32:31.610Z",
  "modified": "2025-07-17T08:32:31.610Z",
  "deleted": "2025-07-17T08:32:31.610Z",
  "uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
  "source_ref": "string",
  "status": "string",
  "reference": "string",
  "referral_date": "string",
  "sending_agent": -2147483648,
  "sending_branch": -2147483648,
  "recipient_agent": -2147483648,
  "recipient_branch": -2147483648,
  "referral_type": "string",
  "seller_lightstone_id": -2147483648,
  "lightstone_data": null,
  "seller_listing_type": "string",
  "seller_property_types": [],
  "seller_property_listed": false,
  "seller_property_listed_date": "string",
  "seller_property_listed_contracted": false,
  "seller_property_listed_sold": false,
  "seller_possession_date": "string",
  "seller_bank_name": "string",
  "seller_bank_reference": "string",
  "seller_web_reference": "string",
  "seller_valuation_price": "0.00",
  "seller_mandate_days": "string",
  "buyer_price_from": "0.00",
  "buyer_price_to": "0.00",
  "buyer_must_sell": false,
  "buyer_property_listed": false,
  "buyer_property_listed_date": "string",
  "buyer_property_listed_contracted": false,
  "buyer_property_listed_sold": false,
  "buyer_possession_date": "string",
  "buyer_cash_buyer": false,
  "buyer_financed": false,
  "buyer_areas": [],
  "buyer_suburbs": [],
  "buyer_listing_type": "string",
  "buyer_property_types": [],
  "buyer_lease_date": "string",
  "buyer_lease_period": "string",
  "sender_comment": "string",
  "recipient_comment": "string",
  "documents": [],
  "completion_date": "string",
  "transaction_date": "string",
  "referral_outcome": "string",
  "decline_reason": "string",
  "recipient_outcome_comment": "string",
  "contact": 0,
  "created_contact": 0,
  "recipient_contact": 0
}

Name	Description
id	integer ID
tags nullable	array of strings Choices: [ 1,2,3...2147483648 ]
site	integer Site
direction nullable	stringnon-empty Direction
meta	string Meta
expiry_date nullable	string Expiry date
created	string Created
modified	string Modified
deleted nullable	string Deleted
uuid	string Uuid
source_ref nullable	string<= 100 characters Source ref
status required	string Status Choices: ScheduledAcceptedPendingDeclined
reference nullable	string<= 35 characters Reference
referral_date required	string Referral date
sending_agent required	integer Sending agent
sending_branch required	integer Sending branch
recipient_agent required	integer Recipient agent
recipient_branch required	integer Recipient branch
referral_type nullable	string Referral type Choices: Bank distressed saleClient wants to buyClient wants to buy and sellClient wants to leaseClient wants to rentClient wants to sell
seller_lightstone_id nullable	integer Seller lightstone id
lightstone_data nullable	object Lightstone data
seller_listing_type nullable	string Seller listing type Choices: Residential For SaleCommercial For SaleResidential To LetCommercial To Let
seller_property_types nullable	array of strings Seller property types Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreClubClusterCo-working SpaceCompoundDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityVacant LandVillaWarehouseWorkshop
seller_property_listed	boolean Seller property listed
seller_property_listed_date nullable	string Seller property listed date
seller_property_listed_contracted	boolean Seller property listed contracted
seller_property_listed_sold	boolean Seller property listed sold
seller_possession_date nullable	string Seller possession date
seller_bank_name nullable	string Seller bank name Choices: Absa BankNedbankStandard BankFNBSA Home Loans
seller_bank_reference nullable	string<= 200 characters Seller bank reference
seller_web_reference nullable	string<= 200 characters Seller web reference
seller_valuation_price nullable	string Seller valuation price
seller_mandate_days nullable	string Seller mandate days Choices: 7 days30 days60 days90 days120 days
buyer_price_from nullable	string Buyer price from
buyer_price_to nullable	string Buyer price to
buyer_must_sell	boolean Buyer must sell
buyer_property_listed	boolean Buyer property listed
buyer_property_listed_date nullable	string Buyer property listed date
buyer_property_listed_contracted	boolean Buyer property listed contracted
buyer_property_listed_sold	boolean Buyer property listed sold
buyer_possession_date nullable	string Buyer possession date
buyer_cash_buyer	boolean Buyer cash buyer
buyer_financed	boolean Buyer financed
buyer_areas nullable	array of integers Buyer areas Choices: [ 1,2,3...2147483648 ]
buyer_suburbs nullable	array of integers Buyer suburbs Choices: [ 1,2,3...2147483648 ]
buyer_listing_type nullable	string Buyer listing type Choices: Residential For SaleCommercial For SaleResidential To LetCommercial To Let
buyer_property_types nullable	array of strings Buyer property types Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreClubClusterCo-working SpaceCompoundDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityVacant LandVillaWarehouseWorkshop
buyer_lease_date nullable	string Buyer lease date
buyer_lease_period nullable	string Buyer lease period Choices: 1 month2 months3 months6 months9 months12 months24 months36 months48 months60 months10 year plus15 year plus25 year plus35 year plusNegotiable
sender_comment nullable	string Sender comment
recipient_comment nullable	string Recipient comment
documents nullable	array of integers Documents Choices: [ 1,2,3...2147483648 ]
completion_date nullable	string Completion date
transaction_date nullable	string Transaction date
referral_outcome nullable	string Referral outcome Choices: TransactedNo Transaction
decline_reason nullable	string Decline reason Choices: Already have clientBuyer already purchasedBuyer rented insteadBuyer specifications not valid in this areaClient not committed to buyingNot in my areaClient does not want to sellClient has rented the propertyClient only wanted a valuationMandate given to another agencyProperty already listedNot my zoning typePrice range not valid in this areaWas not contacted by referring officeOther...
recipient_outcome_comment nullable	string Recipient outcome comment
contact required	integer Contact
created_contact nullable	integer Created contact
recipient_contact nullable	integer Recipient contact

Name

Description

integer

Meta

expiry_date

nullable

string

Expiry date

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

status

required

string

Status

Choices: ScheduledAcceptedPendingDeclined

reference

nullable

string<= 35 characters

Reference

referral_date

required

string

Referral date

sending_agent

required

integer

Sending agent

sending_branch

required

integer

Sending branch

recipient_agent

required

integer

Recipient agent

recipient_branch

required

integer

Recipient branch

referral_type

nullable

string

Referral type

Choices: Bank distressed saleClient wants to buyClient wants to buy and sellClient wants to leaseClient wants to rentClient wants to sell

seller_lightstone_id

nullable

integer

Seller lightstone id

lightstone_data

nullable

object

Lightstone data

seller_listing_type

nullable

string

Seller listing type

Choices: Residential For SaleCommercial For SaleResidential To LetCommercial To Let

seller_property_types

nullable

array of strings

Seller property types

Choices: Airport HangerApartmentApartment BlockBar/PubBed & BreakfastBuildingBungalowBusinessBusiness CentreClubClusterCo-working SpaceCompoundDetachedDuetDuplexEquestrian PropertyFactoryFarmFlatFreeholdFreestandingFull FloorGarden CottageGated EstateGolf EstateGuest HouseGuesthouseHalf FloorHotelHotel RoomHouseIndustrial YardInvestmentLabour CampLeasebackLodgeMaisonetteMedical SuiteMini FactoryOfficePackage HomePenthousePlace of WorshipRestaurantRetailRetirement UnitRoomSectional TitleSemi DetachedService StationServiced OfficeShowroomSimplexSmall HoldingStaff AccommodationStorage UnitStudio ApartmentTownhouseTraining FacilityVacant LandVillaWarehouseWorkshop

seller_property_listed

boolean

Seller property listed

seller_property_listed_date

nullable

string

Seller property listed date

seller_property_listed_contracted

boolean

Seller property listed contracted

seller_property_listed_sold

boolean

Seller property listed sold

seller_possession_date

nullable

string

Seller possession date

seller_bank_name

nullable

string

Seller bank name

Choices: Absa BankNedbankStandard BankFNBSA Home Loans

seller_bank_reference

nullable

string<= 200 characters

Seller bank reference

seller_web_reference

nullable

string<= 200 characters

Seller web reference

seller_valuation_price

nullable

string

Seller valuation price

seller_mandate_days

nullable

string

Seller mandate days

Choices: 7 days30 days60 days90 days120 days

buyer_price_from

nullable

string

Buyer price from

buyer_price_to

nullable

string

Buyer price to

buyer_must_sell

boolean

Buyer must sell

buyer_property_listed

boolean

Buyer property listed

buyer_property_listed_date

nullable

string

Buyer property listed date

buyer_property_listed_contracted

boolean

Buyer property listed contracted

buyer_property_listed_sold

boolean

Buyer property listed sold

buyer_possession_date

nullable

string

Buyer possession date

buyer_cash_buyer

boolean

Buyer cash buyer

buyer_financed

boolean

Buyer financed

buyer_areas

nullable

array of integers

Buyer areas

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

buyer_suburbs

nullable

array of integers

Buyer suburbs

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

buyer_listing_type

nullable

string

Buyer listing type

Choices: Residential For SaleCommercial For SaleResidential To LetCommercial To Let

buyer_property_types

nullable

array of strings

Buyer property types

buyer_lease_date

nullable

string

Buyer lease date

buyer_lease_period

nullable

string

Buyer lease period

Choices: 1 month2 months3 months6 months9 months12 months24 months36 months48 months60 months10 year plus15 year plus25 year plus35 year plusNegotiable

sender_comment

nullable

string

Sender comment

recipient_comment

nullable

string

Recipient comment

documents

nullable

array of integers

Documents

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

completion_date

nullable

string

Completion date

transaction_date

nullable

string

Transaction date

referral_outcome

nullable

string

Referral outcome

Choices: TransactedNo Transaction

decline_reason

nullable

string

Decline reason

Choices: Already have clientBuyer already purchasedBuyer rented insteadBuyer specifications not valid in this areaClient not committed to buyingNot in my areaClient does not want to sellClient has rented the propertyClient only wanted a valuationMandate given to another agencyProperty already listedNot my zoning typePrice range not valid in this areaWas not contacted by referring officeOther...

recipient_outcome_comment

nullable

string

Recipient outcome comment

contact

required

integer

Contact

created_contact

nullable

integer

Created contact

recipient_contact

nullable

integer

Recipient contact

Responses

201

400 Bad request body

403 You do not have permission to perform this action

500 Internal server error

503 This website is not active