API Bulk Update Leads - Shape Software - Automate your business!

Instructions

Shape Software API

  • Introduction
  • Using Shape APIs
  • Status Codes
  • Rate Limits

POST API Calls

GET API Calls

Bulk Update Leads

POST /leads/bulk/update

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

Parameters

This API endpoint accepts arrays of objects, each object is considered a lead. Update leads via Lead ID and include the field names to be updated in the request body. To get a list of supported field names, please see the section below titled “How to Get Field Names.”

Parameter — Lead ID is required in each object of the array passed to this endpoint

Parameter — To get a list of supported field names, please see the section below titled “How to Get Field Names.”

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:

[
    {
        "id" : 60679,
        "firstname" : "John",
        "lastname" : "Doe",
        "borrower_commissions" : 123,
        "borrower_overtime" : 18,
        "boremployer" : "Employer Name",
        "boryearsonjob" : 2
    },
    {
        "id" : 60673,
        "firstname" : "Jane",
        "lastname" : "Doe",
        "borrower_commissions" : 234,
        "borrower_overtime" : 19,
        "boremployer" : "Employer Name",
        "boryearsonjob" : 5
    }
]

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": "Leads Updated successfully",
    "columns_not_found": [],
    "lead_ids": [
        60679,
        60673
    ]
}

*columns_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.