API Bulk Lead Select - Shape Software - Automate your business!

Instructions

Shape Software API

POST API Calls

GET API Calls

Bulk Select Leads

POST /bulk/lead/select

To select leads in bulk, send an authorized POST request to  https://secure.setshape.com/api/bulk/lead/select

Parameters

This API endpoint accepts an object having two keys, “ids” which are the lead IDs and “fields” which is the fields needed to fetch the lead IDs. You can get list of field names as a CSV file, Please read “How to get field names for update lead” section:

Parameter — Array of Lead IDs

Parameter — Array of fields found in Campaign Source Post URL instructions in the Settings pages. (required)

Request Header

The authentication token should be passed in the request header for every API request. 

Content-Type: application/json
Authorization=xxxxxxxxxxxxxxxxxxxxxxxx

Request Body

JSON request body formatting example:

{
    "ids" : [56350467, 56350209],
    "fields": ["firstname","lastname","email", "lastcallattempt", "mainhomephone", 
"acacampusinterest", "acaprograminterest", "zip", "lead_type", "mainaltremail", "depursAd"] }

Response

Upon success, the server returns HTTP codes and messages in the header with some additional elements and properties that are set by the server, such as id.

{
    "message": "Data fetched successfully.",
    "data": {
        "56350467": {
            "firstname": "Mike",
            "lastname": "Johnson",
            "email": "mikejohnson@gmail.com",
            "lastCall": "2020-06-30 15:25:36",
            "altphone": "",
            "campusinterest": "USC",
            "programinterest": "Business",
            "zip": "53186",
            "mainleadtype": "Admissions",
            "altremail": "",
            "metavalue": "31"
        },
        "56350209": {
            "firstname": "Jessica",
            "lastname": "Smith",
            "email": "jesssmith@gmail.com",
            "lastCall": "2020-06-29 19:04:09",
            "altphone": "",
            "campusinterest": "UCLA",
            "programinterest": "Science",
            "zip": "",
            "mainleadtype": "Recruiting",
            "altremail": "",
            "metavalue": "31"
        }
    },
    "fields_not_found": []
}

*fields_not_found: This response key is an array indicating items passed through the API endpoint, but does not exists within Shape Software.

How to Get Field Names

Field names can be found within your CRM System’s settings pages under: Settings > Marketing Sources > Edit Any Marketing Source > Campaign Source Post URL Instructions.

 

After navigating to the marketing sources settings page and opening up a campaign, scroll to the bottom of the page to the “Campaign Source Post URL Instructions” section. Here, you will find a searchable table with a breakdown of all of the field names available for use. These field names can also be exported to a CSV via the “Export” dropdown.