Sign in

v1

latestOpenAPI 3.0.02026-08-04109109370.6 KB
Leads

Update the status of a lead.

Update the status of a lead, for example, close a lead as won or lost. Also allows for setting the outcome of the lead, and competitor and product maps.

post/leads/{id}/status

Path parameters

idstring required

ID of the lead to update the status of

Request body

outcomeIdstring

ID of the outcome to set for the lead

competitorMapsstring[]

Array of competitor maps ids

Example request

{
  "outcomeId": "1-outcomes",
  "competitorMaps": [
    "1-competitorMaps"
  ],
  "productMaps": [
    {
      "id": "3-contacts",
      "price": {
        "formatted": "$100.00",
        "amount": "100.00",
        "currency": "USD"
      },
      "productType": "product",
      "links": {
        "product": "1-products"
      }
    }
  ]
}

Response

Lead

htmlUrlstring

The link to the entity within the app.

htmlUrlPathstring

The path to the entity within the app.

avatarUrlstring

The URL of the entity's avatar image.

initialsstring

The initials of the entity, used as a fallback for the avatar image.

idstring

The API ID of this entity, formatted {integer}-{entityType}

deletedTimestring
namestring

The full name of the lead

numberinteger
descriptionstring
closedTimestring
dueTimestring
anticipatedClosedTimestring
ownerTypestring
statusstring

The current status of the lead

{"stackTrail":"components:schemas:FullLead:allOf:properties:lastContactedTime","oasType":"schema","type":"unknown","description":"When the lead was last contacted."}
pieStatestring
isOverdueboolean

Whether the lead is overdue to have a final outcome set

overdueTimestring
hrefstring
confidenceinteger

How confident, as a percentage, that the lead will close

priorityinteger

Whether a lead is marked as hot (1) or not (0)

isCurrentUserWatchingboolean

Whether the current authenticated user is subscribed to receive notifications about this lead

Example response

{
  "htmlUrl": "https://app.nutshell.com/lead/1006",
  "htmlUrlPath": "/lead/1006",
  "avatarUrl": "https://app.nutshell.com/avatars/contacts/1006/{path}",
  "initials": "AF",
  "id": "3-contacts",
  "name": "John Doe",
  "value": {
    "formatted": "$100.00",
    "amount": "100.00",
    "currency": "USD"
  },
  "description": "This is a description",
  "createdTime": {
    "absoluteLocalizedString": "May 28, 2024",
    "value": "May 28, 2024"
  },
  "ownerType": "users",
  "status": "open",
  "confidence": 25
}