Update Record Information

Use this API call to update individual records within your Shape instance

POST /update/lead/info

To update a lead, send an authorized JSON POST request to https://secure-api.setshape.com/api/update/lead/info

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 Parameters

Update leads via Lead ID and include the additional 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.

Format

JSON request body formatting example:

{

     “lead_id”: 123,

     “firstname”: “John”,

     “lastname”: “Doe”,

     “phone”: “5555555555”,

     “email”: “johndoe@gmail.com”

}

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”: “Lead Updated successfully”,

     “lead_id”: 123

}

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.