Create Contact

HTTP Request

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

Example Response

{
"id": 0,
"site": 0,
"meta": {},
"entity_directors": [],
"created": "2021-03-01T14:10:07.881Z",
"modified": "2021-03-01T14:10:07.881Z",
"deleted": "2021-03-01T14:10:07.881Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"source": "string",
"first_name": "string",
"id_number": "string",
"last_name": "string",
"email": "user@example.com",
"title": "string",
"cell_number": "string",
"home_number": "string",
"work_number": "string",
"fax_number": "string",
"postal_address": "string",
"physical_address": "string",
"birthday": "string",
"active": false,
"marriage_status": "string",
"contact_types": [],
"entity_type": "string",
"entity_name": "string",
"entity_number": "string",
"entity_trading_name": "string",
"entity_vat_number": "string",
"entity_postal_address": "string",
"introduction_agent": -2147483648,
"associated_agents": [],
"branch": -2147483648,
"spouse": 0,
"statistics": 0
}

NameDescription

id

integer

ID

site

integer

Site

meta

string

Meta

entity_directors

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

source

string

Source

Choices: BayutBoardCanvassingDubizzleEmail CampaignFacebookFlyer / PamphletGoogle DisplayGoogle SearchInstagramMobi SitePamphletPartnerPrint AdPrivate PropertyPromotionProperty 24Property FinderProperty PortalRadio AdReferralShowhouseSocial MediaSpouse / PartnerTV AdWalk-inWebsiteOther

first_name

nullable

string<= 75 characters

First name

id_number

nullable

string<= 13 characters

Id number

last_name

nullable

string<= 75 characters

Last name

email

required

string[ 1...254 ] characters

Email

title

nullable

string<= 75 characters

Title

cell_number

nullable

string<= 20 characters

Cell number

home_number

nullable

string<= 20 characters

Home number

work_number

nullable

string<= 20 characters

Work number

fax_number

nullable

string<= 120 characters

Fax number

postal_address

nullable

string<= 100 characters

Postal address

physical_address

nullable

string<= 100 characters

Physical address

birthday

nullable

string

Birthday

active

boolean

Active

marriage_status

nullable

string

Marriage status

Choices: ANCCOPSingleDivorcedForeign LawCommon LawTribal Law

contact_types

array of strings

Contact types

Choices: BuyerSellerTenantLandlordGeneral Enquiry

entity_type

nullable

string

Entity type

Choices: Bank RepoClosed CorporationNatural PersonPty LtdTrustOtherLLCPLLCPartnershipSole proprietor

entity_name

nullable

string<= 100 characters

Entity name

entity_number

nullable

string<= 100 characters

Entity number

entity_trading_name

nullable

string<= 100 characters

Entity trading name

entity_vat_number

nullable

string<= 100 characters

Entity vat number

entity_postal_address

nullable

string

Entity postal address

introduction_agent

nullable

integer

Introduction agent

associated_agents

nullable

array of integers

Associated agents

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

branch

required

integer

Branch

spouse

nullable

integer

Spouse

statistics

nullable

integer

Statistics

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