---
title: "Create a lead"
method: POST
path: "/leads"
tags: ["Leads"]
---

# Create a lead

`POST /leads`

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

## Request body

- object
  - `leads` object[]
    - `description` string — Description of the lead, which is also set as the name of the lead
    - `manualValue` string — Value of the lead, will override the value calculated from the products
    - `dueTime` DueTime — When the lead is due.
      - `absoluteLocalizedString` string — The value formatted as a string
      - `timestamp` number
      - `value` string — The value to be formatted
    - `customFields` object — Custom fields to add to the Lead.
    - `links` object
      - `accounts` string[] — This can either be the IDs of the accounts the lead should be associated with, or an account object
      - `contacts` string[] — This can either be the IDs of the contacts the lead should be associated with, or a contact object
      - `owner` string — The ID of the user the lead is assigned to
      - `sources` string[] — The IDs of the sources the lead should be associated with
      - `tags` string[] — The tags to attach to the lead
      - `productMaps` LeadProductMap[] — The products to attach to the lead. You need to specify a product ID and under links to map the product to the lead. When specifying the price, quantity, or other root level productMap properties, you need to specify the type and productType as well
        - `id` string — The API ID of this entity, formatted {integer}-{entityType}
        - `relationship` unknown
        - `price` Value
          - `formatted` string — The value formatted as a string
          - `amount` string — The value as a number
          - `currency` string — The currency code
        - `name` unknown
        - `unit` unknown
        - `quantity` number, float
        - `productType` string
        - `links` object
          - `product` string — The product this map is for
      - `competitorMaps` string[]

## Response `201`

Lead

- FullLead — Adds an htmlUrl string attribute that represents a URL of an HTML representation of the response model.
  - `htmlUrl` string — The link to the entity within the app.
  - `htmlUrlPath` string — The path to the entity within the app.
  - `avatarUrl` string — The URL of the entity's avatar image.
  - `initials` string — The initials of the entity, used as a fallback for the avatar image.
  - `id` string — The API ID of this entity, formatted {integer}-{entityType}
  - `deletedTime` string
  - `name` string — The full name of the lead
  - `value` Value
    - `formatted` string — The value formatted as a string
    - `amount` string — The value as a number
    - `currency` string — The currency code
  - `number` integer
  - `description` string
  - `createdTime` CreatedTime — When the lead was created.
    - `absoluteLocalizedString` string — The value formatted as a string
    - `timestamp` number
    - `value` string — The value to be formatted
  - `closedTime` string
  - `dueTime` string
  - `anticipatedClosedTime` string
  - `ownerType` string
  - `status` string — The current status of the lead
  - `lastContactedTime` unknown
  - `pieState` string
  - `isOverdue` boolean — Whether the lead is overdue to have a final outcome set
  - `overdueTime` string
  - `href` string
  - `confidence` integer — How confident, as a percentage, that the lead will close
  - `priority` integer — Whether a lead is marked as hot (1) or not (0)
  - `isCurrentUserWatching` boolean — Whether the current authenticated user is subscribed to receive notifications about this lead

---

[API](https://skmtc.net/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.net/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/versions/91e98426903e/schema)