Create Contact
HTTP Request
POSThttps://staging.api-gw.propdata.net/contacts/api/v1/contacts/
Example Response
{"id": 0,"tags": [],"site": 0,"meta": {},"entity_directors": [],"linked_contacts": [],"consent": 0,"source_ref_exists": "string","physical_address": {"address_line_1": "string","address_line_2": "string","city": "string","province": "string","country": "string","postal_code": "string"},"postal_address": {"address_line_1": "string","address_line_2": "string","city": "string","province": "string","country": "string","postal_code": "string"},"created": "2024-03-28T13:31:10.335Z","modified": "2024-03-28T13:31:10.335Z","deleted": "2024-03-28T13:31:10.335Z","uuid": "770bba28-9f80-4d40-9c51-6e022364af91","source_ref": "string","source": "string","first_name": "string","id_number": "string","last_name": "string","maiden_name": "string","email": "user@example.com","title": "string","cell_number": "string","home_number": "string","work_number": "string","fax_number": "string","birthday": "string","active": false,"status": "string","nationality": "string","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,"unsubscribe_hash": "string","facebook_url": "http://www.example.com","twitter_url": "http://www.example.com","linkedin_url": "http://www.example.com","youtube_url": "http://www.example.com","pinterest_url": "http://www.example.com","google_my_business_url": "http://www.example.com","instagram_url": "http://www.example.com","occupation": "string","job_title": "string","wedding_anniversary": "string","house_anniversary": "string","contact_preference": "string","spouse": 0,"statistics": 0}
Name | Description |
---|---|
id | integer ID |
tags nullable | array of strings Choices: [ 1,2,3...2147483648 ] |
site | integer Site |
meta | string Meta |
entity_directors | array of integers Choices: [ 1,2,3...2147483648 ] |
linked_contacts | array of integers Choices: [ 1,2,3...2147483648 ] |
consent | integer Consent |
source_ref_exists nullable | string Source ref exists |
physical_address | object |
postal_address | object |
created | string Created |
modified | string Modified |
deleted nullable | string Deleted |
uuid | string Uuid |
source_ref nullable | string<= 100 characters Source ref |
source | string SourceChoices: BayutBoardCanvassingDubizzleEmail CampaignFacebookFlowFlyer / PamphletGoogle DisplayGoogle SearchGumtreeHouzaImmoAfricaInstagramJamesEditionLinkedInListGloballyMicrositeMobi SiteOtherPamphletPartnerPersonal ContactPhone InPremPropPrevious ClientPrint AdPrivate PropertyPromotionProperty 24Property CentralProperty FinderProperty HouseProperty PortalProperty360Radio AdReferralShowhouseSocial MediaSpouse / PartnerTPN PropbayTPN RentbayTV AdValuationWalk-inWebsite |
first_name nullable | string<= 75 characters First name |
id_number nullable | string<= 13 characters Id number |
last_name nullable | string<= 75 characters Last name |
maiden_name nullable | string<= 75 characters Maiden name |
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 |
birthday nullable | string Birthday |
active | boolean Active |
status required | string StatusChoices: ActiveInactiveNon-CompliantNo-Consent |
nationality nullable | string<= 120 characters Nationality |
marriage_status nullable | string Marriage statusChoices: ANCANC - AccrualCOPCommon LawDivorcedForeign LawSingleTribal Law |
contact_types | array of strings Contact typesChoices: BuyerGeneral EnquiryLandlordProperty OwnerSellerTenantAttorney |
entity_type nullable | string Entity typeChoices: Bank RepoClosed CorporationLLCNatural PersonOtherPLLCPartnershipPty LtdSole proprietorTrust |
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 agentsChoices: [ 1,2,3...2147483648 ] |
branch required | integer Branch |
unsubscribe_hash nullable | string Unsubscribe hash |
facebook_url nullable | string<= 200 characters Facebook url |
twitter_url nullable | string<= 200 characters Twitter url |
linkedin_url nullable | string<= 200 characters Linkedin url |
youtube_url nullable | string<= 200 characters Youtube url |
pinterest_url nullable | string<= 200 characters Pinterest url |
google_my_business_url nullable | string<= 200 characters Google my business url |
instagram_url nullable | string<= 200 characters Instagram url |
occupation nullable | string<= 50 characters Occupation |
job_title nullable | string<= 50 characters Job title |
wedding_anniversary nullable | string Wedding anniversary |
house_anniversary nullable | string House anniversary |
contact_preference nullable | string Contact preferenceChoices: EmailPhoneWhatsAppPostSMSFax |
spouse nullable | integer Spouse |
statistics nullable | integer Statistics |