PUT api/keypersons/PutKeyPersons
Request Information
URI Parameters
None.
Body Parameters
Collection of KeyPersonDTO| Name | Description | 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. |
|
| 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": "c7bb534a-b402-479d-a37f-35e6e615dcc4",
"PersonQOCID": "458ed668-076c-492d-aa68-ed039eb43a68",
"OfficeQOCID": "d7baa080-82f4-428b-8118-3bb673523fe3",
"SourceID": "sample string 3",
"QOCGUID": "01a49b00-7394-4060-8d71-e76274c5479c",
"KeyPersonTitle": "Accounting_Manager",
"OfficePhone": "sample string 5",
"CellPhone": "sample string 6",
"EffectiveDate": "2026-03-10T01:13:35.4118181+00:00",
"DeactiveDate": "2026-03-10T01:13:35.4118181+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-03-10T01:13:35.4118181+00:00",
"BrandStartDate": "2026-03-10T01:13:35.4118181+00:00",
"REStartDate": "2026-03-10T01:13:35.4118181+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": "98c66b2f-72c3-4c7c-8deb-d4322ded2586",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
},
{
"PersonQOCGUID": "98c66b2f-72c3-4c7c-8deb-d4322ded2586",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
}
]
},
{
"BrokerageQOCID": "c7bb534a-b402-479d-a37f-35e6e615dcc4",
"PersonQOCID": "458ed668-076c-492d-aa68-ed039eb43a68",
"OfficeQOCID": "d7baa080-82f4-428b-8118-3bb673523fe3",
"SourceID": "sample string 3",
"QOCGUID": "01a49b00-7394-4060-8d71-e76274c5479c",
"KeyPersonTitle": "Accounting_Manager",
"OfficePhone": "sample string 5",
"CellPhone": "sample string 6",
"EffectiveDate": "2026-03-10T01:13:35.4118181+00:00",
"DeactiveDate": "2026-03-10T01:13:35.4118181+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-03-10T01:13:35.4118181+00:00",
"BrandStartDate": "2026-03-10T01:13:35.4118181+00:00",
"REStartDate": "2026-03-10T01:13:35.4118181+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": "98c66b2f-72c3-4c7c-8deb-d4322ded2586",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
},
{
"PersonQOCGUID": "98c66b2f-72c3-4c7c-8deb-d4322ded2586",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfKeyPersonDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO">
<KeyPersonDTO>
<Address1>sample string 31</Address1>
<Address2>sample string 32</Address2>
<BirthDate>2026-03-10T01:13:35.4118181+00:00</BirthDate>
<BrandStartDate>2026-03-10T01:13:35.4118181+00:00</BrandStartDate>
<BrokerageQOCID>c7bb534a-b402-479d-a37f-35e6e615dcc4</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-03-10T01:13:35.4118181+00:00</DeactiveDate>
<EffectiveDate>2026-03-10T01:13:35.4118181+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>d7baa080-82f4-428b-8118-3bb673523fe3</OfficeQOCID>
<Password>sample string 19</Password>
<PayeeType>Unknown</PayeeType>
<PersonQOCID>458ed668-076c-492d-aa68-ed039eb43a68</PersonQOCID>
<PersonWebProfiles>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>98c66b2f-72c3-4c7c-8deb-d4322ded2586</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>98c66b2f-72c3-4c7c-8deb-d4322ded2586</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>01a49b00-7394-4060-8d71-e76274c5479c</QOCGUID>
<REStartDate>2026-03-10T01:13:35.4118181+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>
<KeyPersonDTO>
<Address1>sample string 31</Address1>
<Address2>sample string 32</Address2>
<BirthDate>2026-03-10T01:13:35.4118181+00:00</BirthDate>
<BrandStartDate>2026-03-10T01:13:35.4118181+00:00</BrandStartDate>
<BrokerageQOCID>c7bb534a-b402-479d-a37f-35e6e615dcc4</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-03-10T01:13:35.4118181+00:00</DeactiveDate>
<EffectiveDate>2026-03-10T01:13:35.4118181+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>d7baa080-82f4-428b-8118-3bb673523fe3</OfficeQOCID>
<Password>sample string 19</Password>
<PayeeType>Unknown</PayeeType>
<PersonQOCID>458ed668-076c-492d-aa68-ed039eb43a68</PersonQOCID>
<PersonWebProfiles>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>98c66b2f-72c3-4c7c-8deb-d4322ded2586</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>98c66b2f-72c3-4c7c-8deb-d4322ded2586</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>01a49b00-7394-4060-8d71-e76274c5479c</QOCGUID>
<REStartDate>2026-03-10T01:13:35.4118181+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>
</ArrayOfKeyPersonDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of PostResultOfSimpleKeyPersonDTO| Name | Description | 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": "93a8ee28-7e6e-495a-92d1-19d19dc54076",
"PersonQOCID": "db3d73f1-595c-4b15-af2d-ecde7f523599",
"OfficeQOCID": "0e95b6e4-0287-46d5-9207-18418f3c4a36",
"SourceID": "sample string 3",
"QOCGUID": "2695fe85-31a0-436a-9c95-32ec35c1dab7",
"FirstName": "sample string 5",
"LastName": "sample string 6"
}
},
{
"PostStatus": "Successfully",
"Message": "sample string 1",
"SourceEntity": {
"BrokerageQOCID": "93a8ee28-7e6e-495a-92d1-19d19dc54076",
"PersonQOCID": "db3d73f1-595c-4b15-af2d-ecde7f523599",
"OfficeQOCID": "0e95b6e4-0287-46d5-9207-18418f3c4a36",
"SourceID": "sample string 3",
"QOCGUID": "2695fe85-31a0-436a-9c95-32ec35c1dab7",
"FirstName": "sample string 5",
"LastName": "sample string 6"
}
}
]
application/xml, text/xml
Sample:
<ArrayOfPostResultOfSimpleKeyPersonDTOvCGOl4Wv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.APIDTO">
<PostResultOfSimpleKeyPersonDTOvCGOl4Wv>
<Message>sample string 1</Message>
<PostStatus>Successfully</PostStatus>
<SourceEntity>
<BrokerageQOCID>93a8ee28-7e6e-495a-92d1-19d19dc54076</BrokerageQOCID>
<FirstName>sample string 5</FirstName>
<LastName>sample string 6</LastName>
<OfficeQOCID>0e95b6e4-0287-46d5-9207-18418f3c4a36</OfficeQOCID>
<PersonQOCID>db3d73f1-595c-4b15-af2d-ecde7f523599</PersonQOCID>
<QOCGUID>2695fe85-31a0-436a-9c95-32ec35c1dab7</QOCGUID>
<SourceID>sample string 3</SourceID>
</SourceEntity>
</PostResultOfSimpleKeyPersonDTOvCGOl4Wv>
<PostResultOfSimpleKeyPersonDTOvCGOl4Wv>
<Message>sample string 1</Message>
<PostStatus>Successfully</PostStatus>
<SourceEntity>
<BrokerageQOCID>93a8ee28-7e6e-495a-92d1-19d19dc54076</BrokerageQOCID>
<FirstName>sample string 5</FirstName>
<LastName>sample string 6</LastName>
<OfficeQOCID>0e95b6e4-0287-46d5-9207-18418f3c4a36</OfficeQOCID>
<PersonQOCID>db3d73f1-595c-4b15-af2d-ecde7f523599</PersonQOCID>
<QOCGUID>2695fe85-31a0-436a-9c95-32ec35c1dab7</QOCGUID>
<SourceID>sample string 3</SourceID>
</SourceEntity>
</PostResultOfSimpleKeyPersonDTOvCGOl4Wv>
</ArrayOfPostResultOfSimpleKeyPersonDTOvCGOl4Wv>