BrightDoor Web Services API

Click here for a complete list of operations.

CreateContactwithOptIn

This Method is the same as CreateContactWithNote, allows us to create Contact with text messaging enabled/disabled

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter Value
clientID:
centerID:
username:
password:
honorific:
firstname:
middlename:
lastname:
suffix:
company:
spousefirst:
spouselast:
primaryhomephone:
primaryworkphone:
primaryotherphone:
secondaryhomephone:
secondaryworkphone:
secondaryotherphone:
primaryemailhome:
primaryemailwork:
primaryemailother:
secondaryemailhome:
secondaryemailwork:
secondaryemailother:
address:
address2:
city:
state:
zip:
country:
contactstatusid:
initialContactTypeId:
preferredcontactmethod:
primaryleadsourceid:
secondaryleadsourceid:
primaryagentid:
secondaryagentid:
contactInterestId:
addToTour:
contactpassword:
contactnotes:
contactattributes:
TextMessagesOptIn:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /brightbase/wsbrightdoor.asmx HTTP/1.1
Host: fullersothebys.brightdoor.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.brightdoor.com/webservices/CreateContactwithOptIn"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateContactwithOptIn xmlns="http://www.brightdoor.com/webservices/">
      <clientID>string</clientID>
      <centerID>string</centerID>
      <username>string</username>
      <password>string</password>
      <honorific>string</honorific>
      <firstname>string</firstname>
      <middlename>string</middlename>
      <lastname>string</lastname>
      <suffix>string</suffix>
      <company>string</company>
      <spousefirst>string</spousefirst>
      <spouselast>string</spouselast>
      <primaryhomephone>string</primaryhomephone>
      <primaryworkphone>string</primaryworkphone>
      <primaryotherphone>string</primaryotherphone>
      <secondaryhomephone>string</secondaryhomephone>
      <secondaryworkphone>string</secondaryworkphone>
      <secondaryotherphone>string</secondaryotherphone>
      <primaryemailhome>string</primaryemailhome>
      <primaryemailwork>string</primaryemailwork>
      <primaryemailother>string</primaryemailother>
      <secondaryemailhome>string</secondaryemailhome>
      <secondaryemailwork>string</secondaryemailwork>
      <secondaryemailother>string</secondaryemailother>
      <address>string</address>
      <address2>string</address2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <country>string</country>
      <contactstatusid>int</contactstatusid>
      <initialContactTypeId>int</initialContactTypeId>
      <preferredcontactmethod>string</preferredcontactmethod>
      <primaryleadsourceid>int</primaryleadsourceid>
      <secondaryleadsourceid>int</secondaryleadsourceid>
      <primaryagentid>int</primaryagentid>
      <secondaryagentid>int</secondaryagentid>
      <contactInterestId>string</contactInterestId>
      <addToTour>boolean</addToTour>
      <contactpassword>string</contactpassword>
      <contactnotes>string</contactnotes>
      <contactattributes>string</contactattributes>
      <TextMessagesOptIn>boolean</TextMessagesOptIn>
    </CreateContactwithOptIn>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateContactwithOptInResponse xmlns="http://www.brightdoor.com/webservices/">
      <CreateContactwithOptInResult>int</CreateContactwithOptInResult>
    </CreateContactwithOptInResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /brightbase/wsbrightdoor.asmx HTTP/1.1
Host: fullersothebys.brightdoor.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateContactwithOptIn xmlns="http://www.brightdoor.com/webservices/">
      <clientID>string</clientID>
      <centerID>string</centerID>
      <username>string</username>
      <password>string</password>
      <honorific>string</honorific>
      <firstname>string</firstname>
      <middlename>string</middlename>
      <lastname>string</lastname>
      <suffix>string</suffix>
      <company>string</company>
      <spousefirst>string</spousefirst>
      <spouselast>string</spouselast>
      <primaryhomephone>string</primaryhomephone>
      <primaryworkphone>string</primaryworkphone>
      <primaryotherphone>string</primaryotherphone>
      <secondaryhomephone>string</secondaryhomephone>
      <secondaryworkphone>string</secondaryworkphone>
      <secondaryotherphone>string</secondaryotherphone>
      <primaryemailhome>string</primaryemailhome>
      <primaryemailwork>string</primaryemailwork>
      <primaryemailother>string</primaryemailother>
      <secondaryemailhome>string</secondaryemailhome>
      <secondaryemailwork>string</secondaryemailwork>
      <secondaryemailother>string</secondaryemailother>
      <address>string</address>
      <address2>string</address2>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <country>string</country>
      <contactstatusid>int</contactstatusid>
      <initialContactTypeId>int</initialContactTypeId>
      <preferredcontactmethod>string</preferredcontactmethod>
      <primaryleadsourceid>int</primaryleadsourceid>
      <secondaryleadsourceid>int</secondaryleadsourceid>
      <primaryagentid>int</primaryagentid>
      <secondaryagentid>int</secondaryagentid>
      <contactInterestId>string</contactInterestId>
      <addToTour>boolean</addToTour>
      <contactpassword>string</contactpassword>
      <contactnotes>string</contactnotes>
      <contactattributes>string</contactattributes>
      <TextMessagesOptIn>boolean</TextMessagesOptIn>
    </CreateContactwithOptIn>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateContactwithOptInResponse xmlns="http://www.brightdoor.com/webservices/">
      <CreateContactwithOptInResult>int</CreateContactwithOptInResult>
    </CreateContactwithOptInResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /brightbase/wsbrightdoor.asmx/CreateContactwithOptIn?clientID=string&centerID=string&username=string&password=string&honorific=string&firstname=string&middlename=string&lastname=string&suffix=string&company=string&spousefirst=string&spouselast=string&primaryhomephone=string&primaryworkphone=string&primaryotherphone=string&secondaryhomephone=string&secondaryworkphone=string&secondaryotherphone=string&primaryemailhome=string&primaryemailwork=string&primaryemailother=string&secondaryemailhome=string&secondaryemailwork=string&secondaryemailother=string&address=string&address2=string&city=string&state=string&zip=string&country=string&contactstatusid=string&initialContactTypeId=string&preferredcontactmethod=string&primaryleadsourceid=string&secondaryleadsourceid=string&primaryagentid=string&secondaryagentid=string&contactInterestId=string&addToTour=string&contactpassword=string&contactnotes=string&contactattributes=string&TextMessagesOptIn=string HTTP/1.1
Host: fullersothebys.brightdoor.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://www.brightdoor.com/webservices/">int</int>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /brightbase/wsbrightdoor.asmx/CreateContactwithOptIn HTTP/1.1
Host: fullersothebys.brightdoor.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

clientID=string&centerID=string&username=string&password=string&honorific=string&firstname=string&middlename=string&lastname=string&suffix=string&company=string&spousefirst=string&spouselast=string&primaryhomephone=string&primaryworkphone=string&primaryotherphone=string&secondaryhomephone=string&secondaryworkphone=string&secondaryotherphone=string&primaryemailhome=string&primaryemailwork=string&primaryemailother=string&secondaryemailhome=string&secondaryemailwork=string&secondaryemailother=string&address=string&address2=string&city=string&state=string&zip=string&country=string&contactstatusid=string&initialContactTypeId=string&preferredcontactmethod=string&primaryleadsourceid=string&secondaryleadsourceid=string&primaryagentid=string&secondaryagentid=string&contactInterestId=string&addToTour=string&contactpassword=string&contactnotes=string&contactattributes=string&TextMessagesOptIn=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://www.brightdoor.com/webservices/">int</int>