Update Record Status

Use this API call to update an individual record's status within your Shape instance

POST /change/lead/status

To update a lead’s status, send an authorized POST request to https://secure-api.setshape.com/api/change/lead/status

Parameters

Update lead statuses with these parameters. Both are required to pass through the API call

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

  • status

    It is required to send the friendly name of the status through the API. Please use the status name as it appears in Shape exactly. Failure to match statuses exactly may result in new statuses being added to Shape or a failure in the API call. Find statuses in the "Manage Statuses" settings page in your system settings.

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:

{

     “lead_id”: 123,

     “status”: “Appointment Scheduled”

}

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 status updated successfully”,

     “recordID”: 123

}