POST api/brokerages
Request Information
URI Parameters
None.
Body Parameters
BrokerageDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| FranchiseCode | string |
None. |
|
| SourceSystem | string |
None. |
|
| SourceID | string |
None. |
|
| QOCGUID | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| PrimaryStreet | string |
None. |
|
| SecondaryStreet | string |
None. |
|
| City | string |
None. |
|
| StateorProvidence | string |
None. |
|
| PostalCode | string |
None. |
|
| Phone | string |
None. |
|
| Fax | string |
None. |
|
| string |
None. |
||
| SiteURL | string |
None. |
|
| IsActive | boolean |
None. |
|
| IsInternal | boolean |
None. |
|
| BrokerageSataus | BrokerageStatuses |
None. |
|
| StatusDate | date |
None. |
|
| AllowTeamEmail | boolean |
None. |
|
| DirectMailFlag | boolean |
None. |
|
| DisplayteamWeb | boolean |
None. |
|
| BrandMemberSince | date |
None. |
|
| LastModifiedDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"FranchiseCode": "sample string 1",
"SourceSystem": "sample string 2",
"SourceID": "sample string 3",
"QOCGUID": "8d94934e-4f66-48d6-89f2-7de63a5b1d95",
"Name": "sample string 5",
"PrimaryStreet": "sample string 6",
"SecondaryStreet": "sample string 7",
"City": "sample string 8",
"StateorProvidence": "sample string 9",
"PostalCode": "sample string 10",
"Phone": "sample string 11",
"Fax": "sample string 12",
"Email": "sample string 13",
"SiteURL": "sample string 14",
"IsActive": true,
"IsInternal": true,
"BrokerageSataus": "Active",
"StatusDate": "2026-03-10T01:14:02.4626563+00:00",
"AllowTeamEmail": true,
"DirectMailFlag": true,
"DisplayteamWeb": true,
"BrandMemberSince": "2026-03-10T01:14:02.4626563+00:00",
"LastModifiedDate": "2026-03-10T01:14:02.4626563+00:00"
}
application/xml, text/xml
Sample:
<BrokerageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO"> <AllowTeamEmail>true</AllowTeamEmail> <BrandMemberSince>2026-03-10T01:14:02.4626563+00:00</BrandMemberSince> <BrokerageSataus>Active</BrokerageSataus> <City>sample string 8</City> <DirectMailFlag>true</DirectMailFlag> <DisplayteamWeb>true</DisplayteamWeb> <Email>sample string 13</Email> <Fax>sample string 12</Fax> <FranchiseCode>sample string 1</FranchiseCode> <IsActive>true</IsActive> <IsInternal>true</IsInternal> <LastModifiedDate>2026-03-10T01:14:02.4626563+00:00</LastModifiedDate> <Name>sample string 5</Name> <Phone>sample string 11</Phone> <PostalCode>sample string 10</PostalCode> <PrimaryStreet>sample string 6</PrimaryStreet> <QOCGUID>8d94934e-4f66-48d6-89f2-7de63a5b1d95</QOCGUID> <SecondaryStreet>sample string 7</SecondaryStreet> <SiteURL>sample string 14</SiteURL> <SourceID>sample string 3</SourceID> <SourceSystem>sample string 2</SourceSystem> <StateorProvidence>sample string 9</StateorProvidence> <StatusDate>2026-03-10T01:14:02.4626563+00:00</StatusDate> </BrokerageDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BrokerageDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| FranchiseCode | string |
None. |
|
| SourceSystem | string |
None. |
|
| SourceID | string |
None. |
|
| QOCGUID | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| PrimaryStreet | string |
None. |
|
| SecondaryStreet | string |
None. |
|
| City | string |
None. |
|
| StateorProvidence | string |
None. |
|
| PostalCode | string |
None. |
|
| Phone | string |
None. |
|
| Fax | string |
None. |
|
| string |
None. |
||
| SiteURL | string |
None. |
|
| IsActive | boolean |
None. |
|
| IsInternal | boolean |
None. |
|
| BrokerageSataus | BrokerageStatuses |
None. |
|
| StatusDate | date |
None. |
|
| AllowTeamEmail | boolean |
None. |
|
| DirectMailFlag | boolean |
None. |
|
| DisplayteamWeb | boolean |
None. |
|
| BrandMemberSince | date |
None. |
|
| LastModifiedDate | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"FranchiseCode": "sample string 1",
"SourceSystem": "sample string 2",
"SourceID": "sample string 3",
"QOCGUID": "f1254b24-1d8f-4b9a-b7a7-c3556eeac198",
"Name": "sample string 5",
"PrimaryStreet": "sample string 6",
"SecondaryStreet": "sample string 7",
"City": "sample string 8",
"StateorProvidence": "sample string 9",
"PostalCode": "sample string 10",
"Phone": "sample string 11",
"Fax": "sample string 12",
"Email": "sample string 13",
"SiteURL": "sample string 14",
"IsActive": true,
"IsInternal": true,
"BrokerageSataus": "Active",
"StatusDate": "2026-03-10T01:14:02.5720464+00:00",
"AllowTeamEmail": true,
"DirectMailFlag": true,
"DisplayteamWeb": true,
"BrandMemberSince": "2026-03-10T01:14:02.5720464+00:00",
"LastModifiedDate": "2026-03-10T01:14:02.5720464+00:00"
}
application/xml, text/xml
Sample:
<BrokerageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListingHub.Application.Common.DTO"> <AllowTeamEmail>true</AllowTeamEmail> <BrandMemberSince>2026-03-10T01:14:02.5720464+00:00</BrandMemberSince> <BrokerageSataus>Active</BrokerageSataus> <City>sample string 8</City> <DirectMailFlag>true</DirectMailFlag> <DisplayteamWeb>true</DisplayteamWeb> <Email>sample string 13</Email> <Fax>sample string 12</Fax> <FranchiseCode>sample string 1</FranchiseCode> <IsActive>true</IsActive> <IsInternal>true</IsInternal> <LastModifiedDate>2026-03-10T01:14:02.5720464+00:00</LastModifiedDate> <Name>sample string 5</Name> <Phone>sample string 11</Phone> <PostalCode>sample string 10</PostalCode> <PrimaryStreet>sample string 6</PrimaryStreet> <QOCGUID>f1254b24-1d8f-4b9a-b7a7-c3556eeac198</QOCGUID> <SecondaryStreet>sample string 7</SecondaryStreet> <SiteURL>sample string 14</SiteURL> <SourceID>sample string 3</SourceID> <SourceSystem>sample string 2</SourceSystem> <StateorProvidence>sample string 9</StateorProvidence> <StatusDate>2026-03-10T01:14:02.5720464+00:00</StatusDate> </BrokerageDTO>