Bulk Update Records

Use this API call to update multiple records in bulk at once within your Shape instance

POST /leads/bulk/update

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


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.”

  • lead_id

    This is required in order for this API call to work. You should be passing this mapping with the Shape lead ID that you'd like to update.

  • Your Field Mappings*

    Find the available field mappings within the "Marketing Sources" settings page. Use the "Field Name" exactly as it appears in the field name column. If you'd like to send in custom field values, first create custom fields within your system and the custom mappings will automatically appear in your system's available field mappings.

Request Header

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.”

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


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": [

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

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.

Get in Touch

Our team of experts are here to help! Call our sales line at (888) 762-7211


Contact Sales