Update an existing lead | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/lead/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "description": "Best show ever canceled.  Sad."
}'

{
  "contact_ids": [
    "cont_qpjDKxbN3WWsuhaJjg2Qr9pkqHqe1yviZ5BS0dEyz05"
  ],
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-20T05:30:24.854000+00:00",
  "date_updated": "2013-02-20T05:43:41.622000+00:00",
  "description": "Best show ever canceled.  Sad.",
  "html_url": "https://app.close.com/lead/lead_70jZ5hiVt5X31MZ3vJ0R0GJMqJEihkoF7TtSVFbN2ty/",
  "id": "lead_70jZ5hiVt5X31MZ3vJ0R0GJMqJEihkoF7TtSVFbN2ty",
  "name": "Bluth Company",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "status_id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "url": "http://thebluthcompany.tumblr.com/",
  "addresses": [],
  "display_name": "Bluth Company",
  "status_label": "Potential",
  "tasks": [],
  "contacts": [
    {
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2013-02-20T05:30:24.844000+00:00",
      "date_updated": "2013-02-20T05:43:41.611000+00:00",
      "display_name": "Gob",
      "id": "cont_qpjDKxbN3WWsuhaJjg2Qr9pkqHqe1yviZ5BS0dEyz05",
      "name": "Gob",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "title": "sr. vice president",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "emails": [
        {
          "email": "gob@example.com",
          "is_unsubscribed": false,
          "type": "office"
        }
      ],
      "phones": [
        {
          "phone": "+18004445555",
          "type": "office",
          "phone_formatted": "+1 800-444-5555"
        }
      ]
    }
  ],
  "opportunities": []
}

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

1 { "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.:

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

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

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.: ```json { "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.: ```json { "custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add": "Wednesday" } ``` adds "Wednesday" to the list of values which already exist on the given lead.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects any.

Response

Successful response

contact_idslist of strings

created_bystring or null

date_createddatetime

date_updateddatetime

descriptionstring or null

html_urlstring

idstring

namestring or null

organization_idstring

status_idstring

updated_bystring or null

urlstring or null

addresseslist of objects

contacts_summarystring

created_by_namestring or null

display_namestring

integration_linkslist of objects

localtimedatetime or null

primary_address_summarystring or null

primary_emailobject or null

primary_phoneobject or null

recent_callslist of maps from strings to any

sourcestring or null

status_labelstring

summarieslist of maps from strings to any

taskslist of maps from strings to any

updated_by_namestring or null

contactslist of objectsDeprecated

opportunitieslist of objectsDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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

1 { "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.:

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

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