locationSearch

locationSearch

The locationSearch object includes the information needed to determine which organization the lead being created should be assigned to. The two supported parameters for locationSearch are searchText and postalCode.

searchText

The searchText parameter is used to supply a string to geocode an address and create the lat/long used to return an organization from locator or locator landing pages' configuration. searchText should be used for all Radius locator types.

"locationSearch": { 
      "searchText": "< string >"
         },

• Use searchText for the following Locator Types:
  • Radius Only
  • Regions, Territories and Radius

postalCode

The postalCode parameter should only be used when the locator type (associated to the locatorID) is a Region and territory based locator. This parameter is used to return an organization based on the Regions and Territory Codes configured in Command Center.

"locationSearch": {  
        "postalCode": "< string >" 
            },

Use postalCode for the following Locator Types:

• Regions and Territories Only

How to determine if you should use searchText or postalCode

In order to determine which parameter should be included in the locationSearch object you have to determine the type of locator that is associated to your locatorID.

1. Navigate to the Locators page (under Sites) in Command Center
2. Click on the Locator that has the configuration you want to create leads using
3. The Locator Type in the screenshot is Radius Only, so the searchText parameter should be used.

Submit a request to PowerChord customer support portal.