POST api/keypersons/PostKeyPerson

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BrokerageQOCID	globally unique identifier	None.
PersonQOCID	globally unique identifier	None.
OfficeQOCID	globally unique identifier	None.
SourceID	string	None.
QOCGUID	globally unique identifier	None.
KeyPersonTitle	KeyPersonTitles	None.
OfficePhone	string	None.
CellPhone	string	None.
EffectiveDate	date	None.
DeactiveDate	date	None.
IsActive	boolean	None.
ContactSourceID	string	None.
FirstName	string	None.
LastName	string	None.
MidddleName	string	None.
FamiliarName	string	None.
PrintedName	string	None.
CompanyName	string	None.
GenderType	GenderTypes	None.
LanguageSpoken	string	None.
Phone	string	None.
Fax	string	None.
Email	string	None.
TaxID	string	None.
PayeeType	PayeeTypes	None.
BirthDate	date	None.
BrandStartDate	date	None.
REStartDate	date	None.
Password	string	None.
StreetDirection	string	None.
StreetNumber	string	None.
StreetName	string	None.
StreetDesignation	string	None.
StreetSuffix	string	None.
SuiteAptNumber	string	None.
BuildingFloorNumber	string	None.
City	string	None.
StateorProvidence	string	None.
PostalCode	string	None.
Country	string	None.
Address1	string	None.
Address2	string	None.
PersonWebProfiles	Collection of PersonWebProfileDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "BrokerageQOCID": "eee9c167-4ade-48e9-b33c-67e39125d6c3",
  "PersonQOCID": "f0d458a9-09d1-4347-baeb-a07314909fb5",
  "OfficeQOCID": "383172fc-a7fc-4567-94ae-1b12c303769d",
  "SourceID": "sample string 3",
  "QOCGUID": "85d052b3-c7f4-4453-be1d-c0b53962942b",
  "KeyPersonTitle": "Accounting_Manager",
  "OfficePhone": "sample string 5",
  "CellPhone": "sample string 6",
  "EffectiveDate": "2026-05-08T00:44:23.5851447+00:00",
  "DeactiveDate": "2026-05-08T00:44:23.5851447+00:00",
  "IsActive": true,
  "ContactSourceID": "sample string 7",
  "FirstName": "sample string 8",
  "LastName": "sample string 9",
  "MidddleName": "sample string 10",
  "FamiliarName": "sample string 11",
  "PrintedName": "sample string 12",
  "CompanyName": "sample string 13",
  "GenderType": "Male",
  "LanguageSpoken": "sample string 14",
  "Phone": "sample string 15",
  "Fax": "sample string 16",
  "Email": "sample string 17",
  "TaxID": "sample string 18",
  "PayeeType": "Unknown",
  "BirthDate": "2026-05-08T00:44:23.5851447+00:00",
  "BrandStartDate": "2026-05-08T00:44:23.5851447+00:00",
  "REStartDate": "2026-05-08T00:44:23.5851447+00:00",
  "Password": "sample string 19",
  "StreetDirection": "sample string 20",
  "StreetNumber": "sample string 21",
  "StreetName": "sample string 22",
  "StreetDesignation": "sample string 23",
  "StreetSuffix": "sample string 24",
  "SuiteAptNumber": "sample string 25",
  "BuildingFloorNumber": "sample string 26",
  "City": "sample string 27",
  "StateorProvidence": "sample string 28",
  "PostalCode": "sample string 29",
  "Country": "sample string 30",
  "Address1": "sample string 31",
  "Address2": "sample string 32",
  "PersonWebProfiles": [
    {
      "PersonQOCGUID": "a025554b-c659-4945-860a-4378f7f7beb6",
      "ParagraphNumber": 1,
      "ProfileCategory": "sample string 2",
      "ProfileText": "sample string 3"
    },
    {
      "PersonQOCGUID": "a025554b-c659-4945-860a-4378f7f7beb6",
      "ParagraphNumber": 1,
      "ProfileCategory": "sample string 2",
      "ProfileText": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<KeyPersonDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO">
  <Address1>sample string 31</Address1>
  <Address2>sample string 32</Address2>
  <BirthDate>2026-05-08T00:44:23.5851447+00:00</BirthDate>
  <BrandStartDate>2026-05-08T00:44:23.5851447+00:00</BrandStartDate>
  <BrokerageQOCID>eee9c167-4ade-48e9-b33c-67e39125d6c3</BrokerageQOCID>
  <BuildingFloorNumber>sample string 26</BuildingFloorNumber>
  <CellPhone>sample string 6</CellPhone>
  <City>sample string 27</City>
  <CompanyName>sample string 13</CompanyName>
  <ContactSourceID>sample string 7</ContactSourceID>
  <Country>sample string 30</Country>
  <DeactiveDate>2026-05-08T00:44:23.5851447+00:00</DeactiveDate>
  <EffectiveDate>2026-05-08T00:44:23.5851447+00:00</EffectiveDate>
  <Email>sample string 17</Email>
  <FamiliarName>sample string 11</FamiliarName>
  <Fax>sample string 16</Fax>
  <FirstName>sample string 8</FirstName>
  <GenderType>Male</GenderType>
  <IsActive>true</IsActive>
  <KeyPersonTitle>Accounting_Manager</KeyPersonTitle>
  <LanguageSpoken>sample string 14</LanguageSpoken>
  <LastName>sample string 9</LastName>
  <MidddleName>sample string 10</MidddleName>
  <OfficePhone>sample string 5</OfficePhone>
  <OfficeQOCID>383172fc-a7fc-4567-94ae-1b12c303769d</OfficeQOCID>
  <Password>sample string 19</Password>
  <PayeeType>Unknown</PayeeType>
  <PersonQOCID>f0d458a9-09d1-4347-baeb-a07314909fb5</PersonQOCID>
  <PersonWebProfiles>
    <PersonWebProfileDTO>
      <ParagraphNumber>1</ParagraphNumber>
      <PersonQOCGUID>a025554b-c659-4945-860a-4378f7f7beb6</PersonQOCGUID>
      <ProfileCategory>sample string 2</ProfileCategory>
      <ProfileText>sample string 3</ProfileText>
    </PersonWebProfileDTO>
    <PersonWebProfileDTO>
      <ParagraphNumber>1</ParagraphNumber>
      <PersonQOCGUID>a025554b-c659-4945-860a-4378f7f7beb6</PersonQOCGUID>
      <ProfileCategory>sample string 2</ProfileCategory>
      <ProfileText>sample string 3</ProfileText>
    </PersonWebProfileDTO>
  </PersonWebProfiles>
  <Phone>sample string 15</Phone>
  <PostalCode>sample string 29</PostalCode>
  <PrintedName>sample string 12</PrintedName>
  <QOCGUID>85d052b3-c7f4-4453-be1d-c0b53962942b</QOCGUID>
  <REStartDate>2026-05-08T00:44:23.5851447+00:00</REStartDate>
  <SourceID>sample string 3</SourceID>
  <StateorProvidence>sample string 28</StateorProvidence>
  <StreetDesignation>sample string 23</StreetDesignation>
  <StreetDirection>sample string 20</StreetDirection>
  <StreetName>sample string 22</StreetName>
  <StreetNumber>sample string 21</StreetNumber>
  <StreetSuffix>sample string 24</StreetSuffix>
  <SuiteAptNumber>sample string 25</SuiteAptNumber>
  <TaxID>sample string 18</TaxID>
</KeyPersonDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PostResultOfSimpleKeyPersonDTO

Name	Type	Additional information
PostStatus	PostStatuses	None.
Message	string	None.
SourceEntity	SimpleKeyPersonDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "PostStatus": "Successfully",
  "Message": "sample string 1",
  "SourceEntity": {
    "BrokerageQOCID": "775e0004-4f21-4db7-b951-b685c095266b",
    "PersonQOCID": "bd368035-0d8c-40ba-b27b-4091b1211b56",
    "OfficeQOCID": "3d09c942-a0bd-4547-9d9a-31e4bc5fea99",
    "SourceID": "sample string 3",
    "QOCGUID": "33576bae-80cc-4a1c-a840-47235060f25c",
    "FirstName": "sample string 5",
    "LastName": "sample string 6"
  }
}

application/xml, text/xml

Sample:

<PostResultOfSimpleKeyPersonDTOvCGOl4Wv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.APIDTO">
  <Message>sample string 1</Message>
  <PostStatus>Successfully</PostStatus>
  <SourceEntity>
    <BrokerageQOCID>775e0004-4f21-4db7-b951-b685c095266b</BrokerageQOCID>
    <FirstName>sample string 5</FirstName>
    <LastName>sample string 6</LastName>
    <OfficeQOCID>3d09c942-a0bd-4547-9d9a-31e4bc5fea99</OfficeQOCID>
    <PersonQOCID>bd368035-0d8c-40ba-b27b-4091b1211b56</PersonQOCID>
    <QOCGUID>33576bae-80cc-4a1c-a840-47235060f25c</QOCGUID>
    <SourceID>sample string 3</SourceID>
  </SourceEntity>
</PostResultOfSimpleKeyPersonDTOvCGOl4Wv>