CreateContact API Details


Overview

BrightDoor Central CRM contains multiple API methods for creating new contact records. The determining factor in selecting the most applicable method is typically based around the type of data being passed as well as workflow related requirements. Below are technical details related to using the CreateContact method to pass web registrations.

 

Details

Client’s WSDL:

http://<client_name>.brightdoor.com/brightbase/wsbrightdoor.asmx

 

CreateContact URL:

http://<client_name>.brightdoor.com/brightbase/wsbrightdoor.asmx?op=CreateContact

 

The following is a sample SOAP 1.1 request and response. The placeholder values will be replaced with actual values when you are ready to integrate and test. Required fields are and bolded. These fields will require either (1) that you pass a value from your web form or (2) you use a default value we provide.

 

POST /brightbase/wsbrightdoor.asmx HTTP/1.1

Host: <client_name>.brightdoor.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: “http://www.brightdoor.com/webservices/CreateContact”

 

<?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>

<CreateContact xmlns=”http://www.brightdoor.com/webservices/”>

<clientID>1</clientID>

<centerID>1</centerID>

<username>your_webservice_username</username>

<password> your_webservice_password</password>

<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>integer</contactstatusid>

<initialContactTypeId>6</initialContactTypeId>

<preferredcontactmethod>Email</preferredcontactmethod>

<primaryleadsourceid>integer</primaryleadsourceid>

<secondaryleadsourceid>0</secondaryleadsourceid>

<primaryagentid>0</primaryagentid>

<secondaryagentid>0</secondaryagentid>

<contactInterestId>string</contactInterestId>

<addToTour>False</addToTour>

<contactpassword>string</contactpassword>

<contactattributes>string</contactattributes>

</CreateContact>

</soap:Body>

</soap:Envelope>

  

If you are using the “contactattributes” parameter (used to pass form data matched to BrightDoor Central custom attributes), we required that you URL encode the value string.

For example:

  1. 1.     First construct a standard query string with these two attributes:

 

CustomAttribute1=Value1&CustomAttribute2=Value2

 

  1. 2.     Now URL encode this string:

 

CustomAttribute1%3DValue1%26CustomAttribute2%3DValue2

 

  1. 3.     Then just set ContactAttributes value to this new string:

 

CustomAttribute1%3DValue1%26CustomAttribute2%3DValue2