---
title: "Add Lead"
method: PATCH
path: "/leads"
---

# Add Lead

`PATCH /leads`

Adds a new lead. A new non-loyalty customer will be created if you pass a new customer identifier.

## Headers

- `language` string

## Response `200`

200

- object
  - `id` integer
  - `userId` integer
  - `type` string
  - `leadFor` string
  - `status` string
  - `nextFollowUp` string
  - `createdOn` string
  - `createdBy` integer
  - `lastUpdatedOn` string
  - `lastUpdatedBy` integer
  - `followUpDetails` object[]
    - `id` integer
    - `userId` integer
    - `leadId` integer
    - `notes` string
    - `createdBy` integer
    - `createdOn` string
    - `followedUpBy` integer
    - `followedUpOn` string
    - `scheduledFollowUp` string
  - `extendedFields` object
    - `trial_status` string
  - `statusLogDetails` object[]
    - `id` integer
    - `userId` integer
    - `leadId` integer
    - `status` string
    - `createdBy` integer
    - `createdOn` string
    - `reasonId` integer
    - `reason` string
  - `orgSourceId` integer
  - `warnings` unknown[]
    - unknown

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)
