CLclose
leads

Update an existing lead

Changed on

Supports non-destructive patches. Nested contacts cannot be updated through this endpoint -- use the Contacts API instead.

status: See status and status_id guidance on the create endpoint.

custom.FIELD_ID (optional): See custom.FIELD_ID guidance on the create endpoint. You can also unset a single field, e.g.:

{ "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c": null }

If the custom field accepts multiple values, you can specify .add or .remove as part of the field key to add/remove a single value to/from a list of values, e.g.:

{ "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add": "Wednesday" }

adds "Wednesday" to the list of values which already exist on the given lead.

put/lead/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/lead/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Response

Successful response

contact_idsstring[] required
contacts_summarystring
created_bystring nullable required
created_by_agent_idstring nullable

ID of the agent that created the lead, or null if no agent created it.

created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
descriptionstring nullable required
display_namestring
html_urlstring required
idstring required
localtimestring date-time nullable
namestring nullable required
organization_idstring required
primary_address_fullstring nullable
primary_address_summarystring nullable
recent_callsobject[]
sourcestring nullable
status_idstring required
status_labelstring
summariesobject[]
tasksobject[]
updated_bystring nullable required
updated_by_agent_idstring nullable

ID of the agent that last updated the lead, or null if the last update wasn't made by an agent.

updated_by_namestring nullable
urlstring nullable required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the / response property for the status

    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the / response property for the status

  • 784846be4a00Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status