Welcome to the BrightDoor API. These methods are available for BrightDoor, our developers and integration partners to gain data access for their applications and sites. You must have a valid web service username and password in order to test via this WSDL and for actual code implementation. For assistance with details around usage of this API, please contact your assigned BrightDoor Account Manager. You can also visit the BrightDoor Knowledge Base.

The following methods are supported. Select a method for more details and to perform a test query. For a formal definition, please review the Service Description.

• AddContact Basic contact add function (deprecated in 2012)
• AddContactFull Basic contact add function (deprecated in 2012)
• AddContactInterest Add a contact Interest into a contact record
• AddContactRecord Adds a new lead to BrightDoor; most comprehensive and most common for website forms. Click here for Knowledge Base article.
• AddFavorite Used to add a product as a favorite to a contact's record
• AddOnSiteContact Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• AddProduct Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• AddRegisteredContact Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• AddRegisteredSurvey Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• AddSignature Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• AddSurvey Used when adding a survey into a contact's record. Requires a Survey in the database
• AddSurveyCompact Used to add a survey; requires survey answerIDs
• AddTracking Used for BrightDoor applications that use tracking data; NOT FOR 3RD PARTY DEVELOPER USE
• AddUserMessage Method that is used to pass messages between the Buyer Portal and BrightDoor; NOT FOR 3RD PARTY DEVELOPER USE
• AssignAgentToContact Method for assigning an agent to a prospect
• ClearFavorites Deletes all favorites from a contact's record
• CreateActivity Basic create and update activity function
• CreateActivityFromEmail Used with BrightSync feature; NOT FOR 3RD PARTY DEVELOPER USE
• CreateContact Most common used method for passing contacts into the database
• CreateContact2 Method is the same as CreateContact, but allows for a title field
• CreateContactWithNote Method is the same as CreateContact2, allows us to create Contact Note
• CreateContactwithOptIn This Method is the same as CreateContactWithNote, allows us to create Contact with text messaging enabled/disabled
• DeleteFavorite Removes a Favorite from a contact's record
• DeleteProduct Sets a product as 'Inactive' and removes it from Sales Presenter; does NOT delete from the database or UI
• GetAgents Returns IDs for Sales Agents
• GetAgentsByContact Returns the agent assigned based on the contactID
• GetAgentsFullName Get all active agents Firstname, Lastname
• GetAllProductDetails Get All Product Details for specified Product Types, Product Attribute Definitions and Product Statuses (all are required fields)
• GetBrightAppConfigXML Takes BrightDoor username and password as parameters, validates and return the app configuration file for Mobile Inventory
• GetBrightGuideConfigXml Takes web service username and password as parameters, validates and return the app configuration file for BrightDoor Kiosk (aka BrightGuide)
• GetBrightSyncDetails Used with BrightSync feature; NOT FOR 3RD PARTY DEVELOPER USE
• GetChildLeadSources Method that returns child lead sources; helpful if you want to populate a 'How Did you Hear About Us' question
• GetCommunicationMethods Returns the initial communication methods
• GetContactAttributes Returns all the contact attributes for a single contact; is useful if you are wanting to update records via the API
• GetContactByID Returns basic contact information using the contactID
• GetContactByLogin Returns the contact information using the email address and password saved in a profile
• GetContactByUsername Returns the contact information using the email address; helpful if you are trying to duplicate check prior to submitting a new lead
• GetContactDetailsByID Returns basic contact information using the contactID
• GetContactInbox Returns the contact's inbox messages for the Buyer Portal; NOT FOR 3RD PARTY DEVELOPER USE
• GetContactSentItems Returns the contact's sent messages for the Buyer Portal; NOT FOR 3RD PARTY DEVELOPER USE
• GetContactStatuses Returns all contact statuses; helpful if you wish to dynamically assign contacts to a status
• GetContactTypes Returns all contact types
• GetContacts Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• GetContactsByDateRange Takes createdStartDate and createdEndDate and returns contacts. If no date specified then it returns contacts created Today
• GetContactsByEmailAddressesGetContacts Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• GetDetailedLeadSources Gets Parents and their Child Lead Sources
• GetDocumentByID Returns a saved document using the documentID number; used in BD Kiosk; NOT FOR 3RD PARTY DEVELOPER USE
• GetDocumentPlaylists Returns document playlists for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetDocuments Returns documents for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetFavoriteByID Returns information in relationship to a favoriteID
• GetFavorites Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetHotSpots Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetInitialContactTypes Returns the initial communication methods
• GetInterests Returns the interests
• GetInterviewConfigXml Takes web service username and password as parameters, validates and return the app configuration file for Sales Presenter Survey (aka BrightMatch)
• GetLastTracking Returns the last tracked event associated with a contactID or deviceID
• GetLeadSources Returns all lead sources (not separated by parent or child
• GetMarquee Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetMarqueeConfigXml Takes web service username and password as parameters, validates and return the app configuration file for the Sales Presenter Screensaver (aka BrightView)
• GetMediaParameters Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetParentLeadSources Returns parent lead sources
• GetPresenterConfigXml Takes web service username and password as parameters, validates and return the app configuration file for the Sales Presenter (aka BrightShow)
• GetProductAttributeDefinitions Returns the product attribute definitions; includes ID, Name, Data Type, and Values
• GetProductDetails Returns most comprehensive list of products using typeID, statusID, and attributeID; most commonly used for web development. Click here for the Knowledge Base article.
• GetProductStatusList Returns the ProductStatusIDs
• GetProductTypeByID Returns the name of the productType using the ID
• GetProductTypesByParentTypeID Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetProducts Returns product information based on mapID; most commonly used by BrightDoor Apps and not for public us
• GetProductsByProductType Returns products only based on ProductType; does not include custom attributes
• GetProductsByTypeCount Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetProductsByTypePerPage Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetProductsCount Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetProductsOwned Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetProductsPerPage Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetRegistrationConfigXml Takes web service username and password as parameters, validates and return the app configuration file for the Sales Presenter Registration (aka BrightLead)
• GetServerInfo Get the version of BrightBase
• GetSignature Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetStates Returns the state abbreviations
• GetSurvey Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetSurveyByID Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetSurveyResponseHistory Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetSurveyResults Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetSurveys Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• GetTheme Related to BD Buyer Portal theme customization; NOT FOR 3RD PARTY DEVELOPER USE
• GetTracking Returns tracking information used by BrightDoor Apps; NOT FOR 3RD PARTY DEVELOPER USE
• ObsoleteCreateContact Deprecated BrightDoor app method; NOT FOR 3RD PARTY DEVELOPER USE
• PrintMediaDocument Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• PrintProductDocument Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• ProcessDropboxEmail Used internally for Email DropBox sync feature; NOT FOR 3RD PARTY DEVELOPER USE
• RunCustomQuery Use of this method requires approval and coordination with your BrightDoor account manager
• SendBrightGuideDocument Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• SetContactMessageCleared Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• SetContactMessageRead Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• TriggerSync Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• UpdateContact Method used to update contact information; basic information; will overwrite information with blanks if not included in update
• UpdateContactFull Method used to update contact information; more information is included; will overwrite information with blanks if not included in update
• UpdateContactWithID Method used to update a contact with most complete information. Does not append data; overwrites data currently in the database. Best to combine CreateContact and this method together
• UpdateFavoriteAsHidden Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• UpdateFavoriteAsViewed Reserved for BrightDoor apps; NOT FOR 3RD PARTY DEVELOPER USE
• UpdateProduct Method used to update BD Map and Sales Presenter assignment, status, and label for a given productID; NOT FOR 3RD PARTY DEVELOPER USE
• ValidateUser Method used to validate webservice credentials