POST 17.0/app/contacts

Description

Creates a new Contact record

URI Parameters

None.

Details of the contact to create

Name Description Type Additional information
FirstNames

string

None.

LastName

string

None.

TitleId

integer

None.

Salutation

string

None.

Email

string

None.

Mobile

string

None.

HomeTelephone

string

None.

HomeAddress

Address

None.

CompanyName

string

None.

BusinessTelephone

string

None.

BusinessAddress

Address

None.

MailingAddress

ContactMailingAddress

None.

DateOfBirth

date

None.

TypeId

integer

None.

Requirements

NewContactPropertyRequirements

None.

MarketingPreferences

MarketingPreferences

None.

AssignedUserId

integer

None.

SiteId

integer

None.

application/json, text/json

Sample:
{
  "firstNames": "sample string 1",
  "lastName": "sample string 2",
  "titleId": 3,
  "salutation": "sample string 4",
  "email": "sample string 5",
  "mobile": "sample string 6",
  "homeTelephone": "sample string 7",
  "homeAddress": {
    "countryCode": 1,
    "postCode": "sample string 2",
    "propertyName": "sample string 3",
    "street": "sample string 4",
    "locality": "sample string 5",
    "town": "sample string 6",
    "region": "sample string 7",
    "country": "sample string 8"
  },
  "companyName": "sample string 8",
  "businessTelephone": "sample string 9",
  "businessAddress": {
    "countryCode": 1,
    "postCode": "sample string 2",
    "propertyName": "sample string 3",
    "street": "sample string 4",
    "locality": "sample string 5",
    "town": "sample string 6",
    "region": "sample string 7",
    "country": "sample string 8"
  },
  "mailingAddress": 0,
  "dateOfBirth": "2025-01-09T20:41",
  "typeId": 11,
  "requirements": {
    "category": 0,
    "usage": 0,
    "maxPrice": 1.0,
    "minBedrooms": 64
  },
  "marketingPreferences": {
    "post": true,
    "email": true,
    "smsText": true,
    "telephone": true,
    "passDetailsToThirdParties": true,
    "passDetailsToIFA": true,
    "passDetailsToConveyancer": true
  },
  "assignedUserId": 12,
  "siteId": 13
}

application/xml, text/xml

Sample:
<NewContact xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FirstNames>sample string 1</FirstNames>
  <LastName>sample string 2</LastName>
  <TitleId>3</TitleId>
  <Salutation>sample string 4</Salutation>
  <Email>sample string 5</Email>
  <Mobile>sample string 6</Mobile>
  <HomeTelephone>sample string 7</HomeTelephone>
  <HomeAddress>
    <CountryCode>1</CountryCode>
    <PostCode>sample string 2</PostCode>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Locality>sample string 5</Locality>
    <Town>sample string 6</Town>
    <Region>sample string 7</Region>
    <Country>sample string 8</Country>
  </HomeAddress>
  <CompanyName>sample string 8</CompanyName>
  <BusinessTelephone>sample string 9</BusinessTelephone>
  <BusinessAddress>
    <CountryCode>1</CountryCode>
    <PostCode>sample string 2</PostCode>
    <PropertyName>sample string 3</PropertyName>
    <Street>sample string 4</Street>
    <Locality>sample string 5</Locality>
    <Town>sample string 6</Town>
    <Region>sample string 7</Region>
    <Country>sample string 8</Country>
  </BusinessAddress>
  <MailingAddress>Home</MailingAddress>
  <DateOfBirth>2025-01-09T20:41:34.8855951+00:00</DateOfBirth>
  <TypeId>11</TypeId>
  <Requirements>
    <Category>Sales</Category>
    <Usage>Residential</Usage>
    <MaxPrice>1</MaxPrice>
    <MinBedrooms>64</MinBedrooms>
  </Requirements>
  <MarketingPreferences>
    <Post>true</Post>
    <Email>true</Email>
    <SmsText>true</SmsText>
    <Telephone>true</Telephone>
    <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
    <PassDetailsToIFA>true</PassDetailsToIFA>
    <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
  </MarketingPreferences>
  <AssignedUserId>12</AssignedUserId>
  <SiteId>13</SiteId>
</NewContact>

application/x-www-form-urlencoded

Sample:

Sample not available.

Id of the created Contact

Name Description Type Additional information
Id

integer

None.

application/json, text/json

Sample:
{
  "id": 1
}

application/xml, text/xml

Sample:
<NewRecord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
</NewRecord>