Create Lead

HTTP Request

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

Example Response

{
  "id": 0,
  "tags": [],
  "site": 0,
  "meta": {},
  "contact": 0,
  "interactions": [],
  "notify": false,
  "created": "2025-09-08T12:20:18.476Z",
  "modified": "2025-09-08T12:20:18.476Z",
  "deleted": "2025-09-08T12:20:18.476Z",
  "uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
  "source_ref": "string",
  "status": "string",
  "agent": -2147483648,
  "team": -2147483648,
  "active": false,
  "telephonic": false,
  "source": "string",
  "asking_price": "0.00",
  "property_address": "string",
  "source_description": "string",
  "residential": -2147483648,
  "holiday": -2147483648,
  "commercial": -2147483648,
  "project": -2147483648,
  "message": "string",
  "description": "string",
  "lead_type": "string",
  "stage": "string",
  "page_url": "string",
  "lightstone_id": -2147483648,
  "lightstone_data": null,
  "profile": 0
}

NameDescription

id

integer

ID

tags

nullable

array of strings

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

site

integer

Site

meta

string

Meta

contact

required

integer

Contact

interactions

array of integers

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

notify

boolean

Notify

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

agent

nullable

integer

Agent

team

nullable

integer

Team

active

boolean

Active

telephonic

boolean

Telephonic

source

required

string

Source

Choices: AnanziBayutBoardCanvassingDigs ConnectDubizzleEmail CampaignFindHomesfindmyFacebookFlowFlyer / PamphletGoogle DisplayGoogle SearchGumtreeHouzaHouseFinder NamibiaImmoAfricaInstagramIOL PropertyJamesEditionJunkMailLinkedInProperstarLuxury Property SelectionMicrositeMiningiMobi SiteMyRoofOffrOtherPamphletPartnerPersonal ContactPhone InPremPropPrevious ClientPrint AdPrivate PropertyPromotionPropertiez.co.zaProperty 24Property CentralPropertyEndProperty FinderProperty GeeksProperty HouseProperty PortalProperty SpecialistProperty360Property Near MePX Property HubRadio AdReferralRSA PropertyShowhouseSocial MediaSpouse / PartnerTPN PropbayTPN RentbayTV AdUnderOneRoofValuationWalk-inWebsite

asking_price

nullable

string

Asking price

property_address

nullable

string

Property address

source_description

nullable

string

Source description

residential

nullable

integer

Residential

holiday

nullable

integer

Holiday

commercial

nullable

integer

Commercial

project

nullable

integer

Project

message

required

stringnon-empty

Message

description

nullable

string

Description

lead_type

required

string

Lead type

Choices: BuyerGeneral EnquiryLandlordProperty OwnerSellerTenantAttorneyInsurance Contact

stage

string

Stage

Choices: NewContactedViewingOfferSold

page_url

nullable

string

Page url

lightstone_id

nullable

integer

Lightstone id

lightstone_data

nullable

object

Lightstone data

profile

nullable

integer

Profile

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