BrightDoor Web Services API

Click here for a complete list of operations.

AddContactRecord

Adds a new lead to BrightDoor; most comprehensive and most common for website forms. Click here for Knowledge Base article.

Test

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

Parameter Value
clientID:
centerID:
username:
password:
preferredEmail:
contactPassword:
firstName:
lastName:
address:
city:
state:
zip:
preferredPhone:
contactStatusID:
contactTypeID:
initialContactTypeID:
preferredCommunicationMethod:
interestIDs:
primaryLeadSourceID:
secondaryLeadSourceID:
overwriteDuplicate:
addToTour:
interactionsData:

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/AddContactRecord"

<?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>
    <AddContactRecord xmlns="http://www.brightdoor.com/webservices/">
      <clientID>string</clientID>
      <centerID>string</centerID>
      <username>string</username>
      <password>string</password>
      <preferredEmail>string</preferredEmail>
      <contactPassword>string</contactPassword>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <preferredPhone>string</preferredPhone>
      <contactStatusID>string</contactStatusID>
      <contactTypeID>string</contactTypeID>
      <initialContactTypeID>string</initialContactTypeID>
      <preferredCommunicationMethod>string</preferredCommunicationMethod>
      <interestIDs>string</interestIDs>
      <primaryLeadSourceID>string</primaryLeadSourceID>
      <secondaryLeadSourceID>string</secondaryLeadSourceID>
      <overwriteDuplicate>boolean</overwriteDuplicate>
      <addToTour>boolean</addToTour>
      <interactionsData>string</interactionsData>
    </AddContactRecord>
  </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>
    <AddContactRecordResponse xmlns="http://www.brightdoor.com/webservices/" />
  </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>
    <AddContactRecord xmlns="http://www.brightdoor.com/webservices/">
      <clientID>string</clientID>
      <centerID>string</centerID>
      <username>string</username>
      <password>string</password>
      <preferredEmail>string</preferredEmail>
      <contactPassword>string</contactPassword>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <state>string</state>
      <zip>string</zip>
      <preferredPhone>string</preferredPhone>
      <contactStatusID>string</contactStatusID>
      <contactTypeID>string</contactTypeID>
      <initialContactTypeID>string</initialContactTypeID>
      <preferredCommunicationMethod>string</preferredCommunicationMethod>
      <interestIDs>string</interestIDs>
      <primaryLeadSourceID>string</primaryLeadSourceID>
      <secondaryLeadSourceID>string</secondaryLeadSourceID>
      <overwriteDuplicate>boolean</overwriteDuplicate>
      <addToTour>boolean</addToTour>
      <interactionsData>string</interactionsData>
    </AddContactRecord>
  </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>
    <AddContactRecordResponse xmlns="http://www.brightdoor.com/webservices/" />
  </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/AddContactRecord?clientID=string&centerID=string&username=string&password=string&preferredEmail=string&contactPassword=string&firstName=string&lastName=string&address=string&city=string&state=string&zip=string&preferredPhone=string&contactStatusID=string&contactTypeID=string&initialContactTypeID=string&preferredCommunicationMethod=string&interestIDs=string&primaryLeadSourceID=string&secondaryLeadSourceID=string&overwriteDuplicate=string&addToTour=string&interactionsData=string HTTP/1.1
Host: fullersothebys.brightdoor.com

HTTP/1.1 200 OK

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/AddContactRecord 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&preferredEmail=string&contactPassword=string&firstName=string&lastName=string&address=string&city=string&state=string&zip=string&preferredPhone=string&contactStatusID=string&contactTypeID=string&initialContactTypeID=string&preferredCommunicationMethod=string&interestIDs=string&primaryLeadSourceID=string&secondaryLeadSourceID=string&overwriteDuplicate=string&addToTour=string&interactionsData=string
HTTP/1.1 200 OK