Use this API call to select or request record information in bulk using the Shape lead ID
To select records in bulk, send an authorized POST request to https://secure-api.setshape.com/api/bulk/lead/select
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. Please read “How to get field names for update lead” section:
The authentication token must be passed in the request header for every API request. You can find and generate your authentication token in your system settings page under “API Integrations.”
JSON request body formatting example:
{
“ids” : [56350467, 56350209],
“fields”: [“firstname”,”lastname”,”email”, “lastcallattempt”, “leadsource“]
}
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.
{
“ids” : [56350467, 56350209],
“message”: “Data fetched successfully.”,
“data”: {
“56350467”: {
“firstname”: “Mike”,
“lastname”: “Johnson”,
“email”: “mikejohnson@gmail.com”,
“lastcallattempt”: “2023-06-30 15:25:36”,
“leadsource”: “Mailer”
},
“56350209”: {
“firstname”: “Jessica”,
“lastname”: “Smith”,
“email”: “jesssmith@gmail.com”,
“lastcallattempt”: “2023-06-30 15:42:01”,
“leadsource”: “Mailer”
}
},
“fields_not_found”: []
}
*fields_not_found: This response key is an array indicating items passed through the API endpoint, but do not exists within Shape. If this is empty, then all items were successfully found.
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.
