PUT api/agents/PutAgent

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.
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.
Email	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": "1d66ef20-4646-4ef8-9fe4-25b8ef9aa1b9",
  "PersonQOCID": "f4f1ae47-6bb8-42bb-b700-010746fe10dc",
  "OfficeQOCID": "4854fff2-cfbb-445d-99bb-798966197ca8",
  "SourceSystem": "sample string 4",
  "TeamQOCID": "508b691f-ee81-4b0f-a503-864de6c1204b",
  "SourceID": "sample string 5",
  "QOCGUID": "4dcafa99-3978-490b-bb75-70a780f6e50a",
  "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-03-10T01:13:07.985516+00:00",
  "DeactiveDate": "2026-03-10T01:13:07.985516+00:00",
  "AnniversaryStartingDate": "2026-03-10T01:13:07.985516+00:00",
  "AnniversaryEndingDate": "2026-03-10T01:13:07.985516+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-03-10T01:13:07.985516+00:00",
  "BrandStartDate": "2026-03-10T01:13:07.985516+00:00",
  "REStartDate": "2026-03-10T01:13:07.985516+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-03-10T01:13:07.985516+00:00",
  "LicenseExpirationDate": "2026-03-10T01:13:07.985516+00:00",
  "PersonWebProfiles": [
    {
      "PersonQOCGUID": "498f79bf-ac33-4a62-8982-c118bb706c04",
      "ParagraphNumber": 1,
      "ProfileCategory": "sample string 2",
      "ProfileText": "sample string 3"
    },
    {
      "PersonQOCGUID": "498f79bf-ac33-4a62-8982-c118bb706c04",
      "ParagraphNumber": 1,
      "ProfileCategory": "sample string 2",
      "ProfileText": "sample string 3"
    }
  ],
  "MLSBoardName": "sample string 42"
}

application/xml, text/xml

Sample:

<AgentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO">
  <Address1>sample string 39</Address1>
  <Address2>sample string 40</Address2>
  <AgentLicenseType>Sales_Associate</AgentLicenseType>
  <AgentTitle>Associate_Broker</AgentTitle>
  <AgentType>Full_Time</AgentType>
  <AnniversaryEndingDate>2026-03-10T01:13:07.985516+00:00</AnniversaryEndingDate>
  <AnniversaryStartingDate>2026-03-10T01:13:07.985516+00:00</AnniversaryStartingDate>
  <BirthDate>2026-03-10T01:13:07.985516+00:00</BirthDate>
  <BrandStartDate>2026-03-10T01:13:07.985516+00:00</BrandStartDate>
  <BrokerageQOCID>1d66ef20-4646-4ef8-9fe4-25b8ef9aa1b9</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-03-10T01:13:07.985516+00:00</DeactiveDate>
  <EffectiveDate>2026-03-10T01:13:07.985516+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-03-10T01:13:07.985516+00:00</LicenseDate>
  <LicenseExpirationDate>2026-03-10T01:13:07.985516+00:00</LicenseExpirationDate>
  <MLSBoardName>sample string 42</MLSBoardName>
  <MLSID>sample string 26</MLSID>
  <MidddleName>sample string 17</MidddleName>
  <OfficePhone>sample string 7</OfficePhone>
  <OfficeQOCID>4854fff2-cfbb-445d-99bb-798966197ca8</OfficeQOCID>
  <Password>sample string 27</Password>
  <PayeeType>Unknown</PayeeType>
  <PersonQOCID>f4f1ae47-6bb8-42bb-b700-010746fe10dc</PersonQOCID>
  <PersonWebProfiles>
    <PersonWebProfileDTO>
      <ParagraphNumber>1</ParagraphNumber>
      <PersonQOCGUID>498f79bf-ac33-4a62-8982-c118bb706c04</PersonQOCGUID>
      <ProfileCategory>sample string 2</ProfileCategory>
      <ProfileText>sample string 3</ProfileText>
    </PersonWebProfileDTO>
    <PersonWebProfileDTO>
      <ParagraphNumber>1</ParagraphNumber>
      <PersonQOCGUID>498f79bf-ac33-4a62-8982-c118bb706c04</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>4dcafa99-3978-490b-bb75-70a780f6e50a</QOCGUID>
  <REStartDate>2026-03-10T01:13:07.985516+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>508b691f-ee81-4b0f-a503-864de6c1204b</TeamQOCID>
  <licenseNumber>sample string 41</licenseNumber>
</AgentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PostResultOfSimpleAgentDTO

Name	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": "49f40ea9-e482-4a9d-ab6f-8a79fb9b8546",
    "PersonQOCID": "e60086f4-1b76-4d7a-a1dc-7d91acc57b83",
    "OfficeQOCID": "aff43d87-94c5-4d1e-8914-8db39a083ba5",
    "SourceID": "sample string 4",
    "QOCGUID": "75a4be5f-120d-42a5-b5a8-2e5cae12b3d1",
    "FirstName": "sample string 6",
    "LastName": "sample string 7"
  }
}

application/xml, text/xml

Sample:

<PostResultOfSimpleAgentDTOvCGOl4Wv 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>49f40ea9-e482-4a9d-ab6f-8a79fb9b8546</BrokerageQOCID>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <OfficeQOCID>aff43d87-94c5-4d1e-8914-8db39a083ba5</OfficeQOCID>
    <PersonQOCID>e60086f4-1b76-4d7a-a1dc-7d91acc57b83</PersonQOCID>
    <QOCGUID>75a4be5f-120d-42a5-b5a8-2e5cae12b3d1</QOCGUID>
    <SourceID>sample string 4</SourceID>
  </SourceEntity>
</PostResultOfSimpleAgentDTOvCGOl4Wv>