v1

OpenAPI 3.0.02026-08-04109109370.6 KB

Leads

Create a lead

Create a new lead. Only one lead can be created at a time.

post/leads

Request body

Example request

{
  "leads": [
    {
      "description": "Car Wash Inc.",
      "manualValue": "999.99",
      "dueTime": {
        "absoluteLocalizedString": "May 28, 2024",
        "value": "May 28, 2024"
      },
      "customFields": {
        "Favorite Number": "12"
      },
      "links": {
        "accounts": [
          "1-accounts"
        ],
        "contacts": [
          "1-contacts"
        ],
        "owner": "1-users",
        "sources": [
          "1-sources"
        ],
        "tags": [
          "1-tags"
        ],
        "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
}