POST api/agents/PostAgents
Request Information
URI Parameters
None.
Body Parameters
Collection of AgentDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| BrokerageQOCID | globally unique identifier |
None. |
|
| PersonQOCID | globally unique identifier |
None. |
|
| OfficeQOCID | globally unique identifier |
None. |
|
| SourceSystem | string |
None. |
|
| TeamQOCID | globally unique identifier |
None. |
|
| SourceID | string |
None. |
|
| QOCGUID | globally unique identifier |
None. |
|
| AgentType | AgentTypes |
None. |
|
| AgentTitle | AgentTitles |
None. |
|
| OfficePhone | string |
None. |
|
| CellPhone | string |
None. |
|
| Profile | string |
None. |
|
| Specialty | string |
None. |
|
| Byline | string |
None. |
|
| IsIndependentAgent | boolean |
None. |
|
| IsActive | boolean |
None. |
|
| SAAwardsLevel | integer |
None. |
|
| EffectiveDate | date |
None. |
|
| DeactiveDate | date |
None. |
|
| AnniversaryStartingDate | date |
None. |
|
| AnniversaryEndingDate | date |
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. |
|
| MLSID | string |
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. |
|
| AgentLicenseType | AgentLicenseTypes |
None. |
|
| licenseNumber | string |
None. |
|
| LicenseDate | date |
None. |
|
| LicenseExpirationDate | date |
None. |
|
| PersonWebProfiles | Collection of PersonWebProfileDTO |
None. |
|
| MLSBoardName | string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"BrokerageQOCID": "600703e2-8ec0-49fe-8e5d-00e8d9e571f7",
"PersonQOCID": "9811deaa-4003-49db-8e5b-a4d1ad077834",
"OfficeQOCID": "a5ff3bb9-9598-47a3-b8c9-ea5cf0457b25",
"SourceSystem": "sample string 4",
"TeamQOCID": "4b7b7c75-0afb-463f-aa2a-3fba01ec9a68",
"SourceID": "sample string 5",
"QOCGUID": "04d8f115-5d91-41fd-bc41-a46f7a33e54a",
"AgentType": "Full_Time",
"AgentTitle": "Associate_Broker",
"OfficePhone": "sample string 7",
"CellPhone": "sample string 8",
"Profile": "sample string 9",
"Specialty": "sample string 10",
"Byline": "sample string 11",
"IsIndependentAgent": true,
"IsActive": true,
"SAAwardsLevel": 1,
"EffectiveDate": "2026-07-28T12:21:42.9746663+00:00",
"DeactiveDate": "2026-07-28T12:21:42.9746663+00:00",
"AnniversaryStartingDate": "2026-07-28T12:21:42.9746663+00:00",
"AnniversaryEndingDate": "2026-07-28T12:21:42.9746663+00:00",
"ContactSourceID": "sample string 14",
"FirstName": "sample string 15",
"LastName": "sample string 16",
"MidddleName": "sample string 17",
"FamiliarName": "sample string 18",
"PrintedName": "sample string 19",
"CompanyName": "sample string 20",
"GenderType": "Male",
"LanguageSpoken": "sample string 21",
"Phone": "sample string 22",
"Fax": "sample string 23",
"Email": "sample string 24",
"TaxID": "sample string 25",
"PayeeType": "Unknown",
"BirthDate": "2026-07-28T12:21:42.9746663+00:00",
"BrandStartDate": "2026-07-28T12:21:42.9746663+00:00",
"REStartDate": "2026-07-28T12:21:42.9746663+00:00",
"MLSID": "sample string 26",
"Password": "sample string 27",
"StreetDirection": "sample string 28",
"StreetNumber": "sample string 29",
"StreetName": "sample string 30",
"StreetDesignation": "sample string 31",
"StreetSuffix": "sample string 32",
"SuiteAptNumber": "sample string 33",
"BuildingFloorNumber": "sample string 34",
"City": "sample string 35",
"StateorProvidence": "sample string 36",
"PostalCode": "sample string 37",
"Country": "sample string 38",
"Address1": "sample string 39",
"Address2": "sample string 40",
"AgentLicenseType": 0,
"licenseNumber": "sample string 41",
"LicenseDate": "2026-07-28T12:21:42.9746663+00:00",
"LicenseExpirationDate": "2026-07-28T12:21:42.9746663+00:00",
"PersonWebProfiles": [
{
"PersonQOCGUID": "09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
},
{
"PersonQOCGUID": "09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
}
],
"MLSBoardName": "sample string 42"
},
{
"BrokerageQOCID": "600703e2-8ec0-49fe-8e5d-00e8d9e571f7",
"PersonQOCID": "9811deaa-4003-49db-8e5b-a4d1ad077834",
"OfficeQOCID": "a5ff3bb9-9598-47a3-b8c9-ea5cf0457b25",
"SourceSystem": "sample string 4",
"TeamQOCID": "4b7b7c75-0afb-463f-aa2a-3fba01ec9a68",
"SourceID": "sample string 5",
"QOCGUID": "04d8f115-5d91-41fd-bc41-a46f7a33e54a",
"AgentType": "Full_Time",
"AgentTitle": "Associate_Broker",
"OfficePhone": "sample string 7",
"CellPhone": "sample string 8",
"Profile": "sample string 9",
"Specialty": "sample string 10",
"Byline": "sample string 11",
"IsIndependentAgent": true,
"IsActive": true,
"SAAwardsLevel": 1,
"EffectiveDate": "2026-07-28T12:21:42.9746663+00:00",
"DeactiveDate": "2026-07-28T12:21:42.9746663+00:00",
"AnniversaryStartingDate": "2026-07-28T12:21:42.9746663+00:00",
"AnniversaryEndingDate": "2026-07-28T12:21:42.9746663+00:00",
"ContactSourceID": "sample string 14",
"FirstName": "sample string 15",
"LastName": "sample string 16",
"MidddleName": "sample string 17",
"FamiliarName": "sample string 18",
"PrintedName": "sample string 19",
"CompanyName": "sample string 20",
"GenderType": "Male",
"LanguageSpoken": "sample string 21",
"Phone": "sample string 22",
"Fax": "sample string 23",
"Email": "sample string 24",
"TaxID": "sample string 25",
"PayeeType": "Unknown",
"BirthDate": "2026-07-28T12:21:42.9746663+00:00",
"BrandStartDate": "2026-07-28T12:21:42.9746663+00:00",
"REStartDate": "2026-07-28T12:21:42.9746663+00:00",
"MLSID": "sample string 26",
"Password": "sample string 27",
"StreetDirection": "sample string 28",
"StreetNumber": "sample string 29",
"StreetName": "sample string 30",
"StreetDesignation": "sample string 31",
"StreetSuffix": "sample string 32",
"SuiteAptNumber": "sample string 33",
"BuildingFloorNumber": "sample string 34",
"City": "sample string 35",
"StateorProvidence": "sample string 36",
"PostalCode": "sample string 37",
"Country": "sample string 38",
"Address1": "sample string 39",
"Address2": "sample string 40",
"AgentLicenseType": 0,
"licenseNumber": "sample string 41",
"LicenseDate": "2026-07-28T12:21:42.9746663+00:00",
"LicenseExpirationDate": "2026-07-28T12:21:42.9746663+00:00",
"PersonWebProfiles": [
{
"PersonQOCGUID": "09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
},
{
"PersonQOCGUID": "09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739",
"ParagraphNumber": 1,
"ProfileCategory": "sample string 2",
"ProfileText": "sample string 3"
}
],
"MLSBoardName": "sample string 42"
}
]
application/xml, text/xml
Sample:
<ArrayOfAgentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO">
<AgentDTO>
<Address1>sample string 39</Address1>
<Address2>sample string 40</Address2>
<AgentLicenseType>Sales_Associate</AgentLicenseType>
<AgentTitle>Associate_Broker</AgentTitle>
<AgentType>Full_Time</AgentType>
<AnniversaryEndingDate>2026-07-28T12:21:42.9746663+00:00</AnniversaryEndingDate>
<AnniversaryStartingDate>2026-07-28T12:21:42.9746663+00:00</AnniversaryStartingDate>
<BirthDate>2026-07-28T12:21:42.9746663+00:00</BirthDate>
<BrandStartDate>2026-07-28T12:21:42.9746663+00:00</BrandStartDate>
<BrokerageQOCID>600703e2-8ec0-49fe-8e5d-00e8d9e571f7</BrokerageQOCID>
<BuildingFloorNumber>sample string 34</BuildingFloorNumber>
<Byline>sample string 11</Byline>
<CellPhone>sample string 8</CellPhone>
<City>sample string 35</City>
<CompanyName>sample string 20</CompanyName>
<ContactSourceID>sample string 14</ContactSourceID>
<Country>sample string 38</Country>
<DeactiveDate>2026-07-28T12:21:42.9746663+00:00</DeactiveDate>
<EffectiveDate>2026-07-28T12:21:42.9746663+00:00</EffectiveDate>
<Email>sample string 24</Email>
<FamiliarName>sample string 18</FamiliarName>
<Fax>sample string 23</Fax>
<FirstName>sample string 15</FirstName>
<GenderType>Male</GenderType>
<IsActive>true</IsActive>
<IsIndependentAgent>true</IsIndependentAgent>
<LanguageSpoken>sample string 21</LanguageSpoken>
<LastName>sample string 16</LastName>
<LicenseDate>2026-07-28T12:21:42.9746663+00:00</LicenseDate>
<LicenseExpirationDate>2026-07-28T12:21:42.9746663+00:00</LicenseExpirationDate>
<MLSBoardName>sample string 42</MLSBoardName>
<MLSID>sample string 26</MLSID>
<MidddleName>sample string 17</MidddleName>
<OfficePhone>sample string 7</OfficePhone>
<OfficeQOCID>a5ff3bb9-9598-47a3-b8c9-ea5cf0457b25</OfficeQOCID>
<Password>sample string 27</Password>
<PayeeType>Unknown</PayeeType>
<PersonQOCID>9811deaa-4003-49db-8e5b-a4d1ad077834</PersonQOCID>
<PersonWebProfiles>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
</PersonWebProfiles>
<Phone>sample string 22</Phone>
<PostalCode>sample string 37</PostalCode>
<PrintedName>sample string 19</PrintedName>
<Profile>sample string 9</Profile>
<QOCGUID>04d8f115-5d91-41fd-bc41-a46f7a33e54a</QOCGUID>
<REStartDate>2026-07-28T12:21:42.9746663+00:00</REStartDate>
<SAAwardsLevel>1</SAAwardsLevel>
<SourceID>sample string 5</SourceID>
<SourceSystem>sample string 4</SourceSystem>
<Specialty>sample string 10</Specialty>
<StateorProvidence>sample string 36</StateorProvidence>
<StreetDesignation>sample string 31</StreetDesignation>
<StreetDirection>sample string 28</StreetDirection>
<StreetName>sample string 30</StreetName>
<StreetNumber>sample string 29</StreetNumber>
<StreetSuffix>sample string 32</StreetSuffix>
<SuiteAptNumber>sample string 33</SuiteAptNumber>
<TaxID>sample string 25</TaxID>
<TeamQOCID>4b7b7c75-0afb-463f-aa2a-3fba01ec9a68</TeamQOCID>
<licenseNumber>sample string 41</licenseNumber>
</AgentDTO>
<AgentDTO>
<Address1>sample string 39</Address1>
<Address2>sample string 40</Address2>
<AgentLicenseType>Sales_Associate</AgentLicenseType>
<AgentTitle>Associate_Broker</AgentTitle>
<AgentType>Full_Time</AgentType>
<AnniversaryEndingDate>2026-07-28T12:21:42.9746663+00:00</AnniversaryEndingDate>
<AnniversaryStartingDate>2026-07-28T12:21:42.9746663+00:00</AnniversaryStartingDate>
<BirthDate>2026-07-28T12:21:42.9746663+00:00</BirthDate>
<BrandStartDate>2026-07-28T12:21:42.9746663+00:00</BrandStartDate>
<BrokerageQOCID>600703e2-8ec0-49fe-8e5d-00e8d9e571f7</BrokerageQOCID>
<BuildingFloorNumber>sample string 34</BuildingFloorNumber>
<Byline>sample string 11</Byline>
<CellPhone>sample string 8</CellPhone>
<City>sample string 35</City>
<CompanyName>sample string 20</CompanyName>
<ContactSourceID>sample string 14</ContactSourceID>
<Country>sample string 38</Country>
<DeactiveDate>2026-07-28T12:21:42.9746663+00:00</DeactiveDate>
<EffectiveDate>2026-07-28T12:21:42.9746663+00:00</EffectiveDate>
<Email>sample string 24</Email>
<FamiliarName>sample string 18</FamiliarName>
<Fax>sample string 23</Fax>
<FirstName>sample string 15</FirstName>
<GenderType>Male</GenderType>
<IsActive>true</IsActive>
<IsIndependentAgent>true</IsIndependentAgent>
<LanguageSpoken>sample string 21</LanguageSpoken>
<LastName>sample string 16</LastName>
<LicenseDate>2026-07-28T12:21:42.9746663+00:00</LicenseDate>
<LicenseExpirationDate>2026-07-28T12:21:42.9746663+00:00</LicenseExpirationDate>
<MLSBoardName>sample string 42</MLSBoardName>
<MLSID>sample string 26</MLSID>
<MidddleName>sample string 17</MidddleName>
<OfficePhone>sample string 7</OfficePhone>
<OfficeQOCID>a5ff3bb9-9598-47a3-b8c9-ea5cf0457b25</OfficeQOCID>
<Password>sample string 27</Password>
<PayeeType>Unknown</PayeeType>
<PersonQOCID>9811deaa-4003-49db-8e5b-a4d1ad077834</PersonQOCID>
<PersonWebProfiles>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
<PersonWebProfileDTO>
<ParagraphNumber>1</ParagraphNumber>
<PersonQOCGUID>09fcc79a-aa40-4ea3-9bf9-b3b3e6ced739</PersonQOCGUID>
<ProfileCategory>sample string 2</ProfileCategory>
<ProfileText>sample string 3</ProfileText>
</PersonWebProfileDTO>
</PersonWebProfiles>
<Phone>sample string 22</Phone>
<PostalCode>sample string 37</PostalCode>
<PrintedName>sample string 19</PrintedName>
<Profile>sample string 9</Profile>
<QOCGUID>04d8f115-5d91-41fd-bc41-a46f7a33e54a</QOCGUID>
<REStartDate>2026-07-28T12:21:42.9746663+00:00</REStartDate>
<SAAwardsLevel>1</SAAwardsLevel>
<SourceID>sample string 5</SourceID>
<SourceSystem>sample string 4</SourceSystem>
<Specialty>sample string 10</Specialty>
<StateorProvidence>sample string 36</StateorProvidence>
<StreetDesignation>sample string 31</StreetDesignation>
<StreetDirection>sample string 28</StreetDirection>
<StreetName>sample string 30</StreetName>
<StreetNumber>sample string 29</StreetNumber>
<StreetSuffix>sample string 32</StreetSuffix>
<SuiteAptNumber>sample string 33</SuiteAptNumber>
<TaxID>sample string 25</TaxID>
<TeamQOCID>4b7b7c75-0afb-463f-aa2a-3fba01ec9a68</TeamQOCID>
<licenseNumber>sample string 41</licenseNumber>
</AgentDTO>
</ArrayOfAgentDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of PostResultOfSimpleAgentDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PostStatus | PostStatuses |
None. |
|
| Message | string |
None. |
|
| SourceEntity | SimpleAgentDTO |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"PostStatus": "Successfully",
"Message": "sample string 1",
"SourceEntity": {
"BrokerageQOCID": "6b823e34-2184-40ff-a628-87ef769cd913",
"PersonQOCID": "f6f88794-9138-4bed-81fc-59684b4670a9",
"OfficeQOCID": "9b383713-2a7e-479a-b6df-f36973d66140",
"SourceID": "sample string 4",
"QOCGUID": "55bed53d-c0f2-4d56-96e7-6a86c473af01",
"FirstName": "sample string 6",
"LastName": "sample string 7"
}
},
{
"PostStatus": "Successfully",
"Message": "sample string 1",
"SourceEntity": {
"BrokerageQOCID": "6b823e34-2184-40ff-a628-87ef769cd913",
"PersonQOCID": "f6f88794-9138-4bed-81fc-59684b4670a9",
"OfficeQOCID": "9b383713-2a7e-479a-b6df-f36973d66140",
"SourceID": "sample string 4",
"QOCGUID": "55bed53d-c0f2-4d56-96e7-6a86c473af01",
"FirstName": "sample string 6",
"LastName": "sample string 7"
}
}
]
application/xml, text/xml
Sample:
<ArrayOfPostResultOfSimpleAgentDTOvCGOl4Wv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.APIDTO">
<PostResultOfSimpleAgentDTOvCGOl4Wv>
<Message>sample string 1</Message>
<PostStatus>Successfully</PostStatus>
<SourceEntity>
<BrokerageQOCID>6b823e34-2184-40ff-a628-87ef769cd913</BrokerageQOCID>
<FirstName>sample string 6</FirstName>
<LastName>sample string 7</LastName>
<OfficeQOCID>9b383713-2a7e-479a-b6df-f36973d66140</OfficeQOCID>
<PersonQOCID>f6f88794-9138-4bed-81fc-59684b4670a9</PersonQOCID>
<QOCGUID>55bed53d-c0f2-4d56-96e7-6a86c473af01</QOCGUID>
<SourceID>sample string 4</SourceID>
</SourceEntity>
</PostResultOfSimpleAgentDTOvCGOl4Wv>
<PostResultOfSimpleAgentDTOvCGOl4Wv>
<Message>sample string 1</Message>
<PostStatus>Successfully</PostStatus>
<SourceEntity>
<BrokerageQOCID>6b823e34-2184-40ff-a628-87ef769cd913</BrokerageQOCID>
<FirstName>sample string 6</FirstName>
<LastName>sample string 7</LastName>
<OfficeQOCID>9b383713-2a7e-479a-b6df-f36973d66140</OfficeQOCID>
<PersonQOCID>f6f88794-9138-4bed-81fc-59684b4670a9</PersonQOCID>
<QOCGUID>55bed53d-c0f2-4d56-96e7-6a86c473af01</QOCGUID>
<SourceID>sample string 4</SourceID>
</SourceEntity>
</PostResultOfSimpleAgentDTOvCGOl4Wv>
</ArrayOfPostResultOfSimpleAgentDTOvCGOl4Wv>