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

# Create a lead

`POST /leads`

## Request

- Base URL: `https://api.helloextend.com`
- URL: `https://api.helloextend.com/leads`
- Auth: none declared. Required headers: `Content-Type`, `Accept`

Creates a lead

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `customer` object: Details about the customer to create the lead for. This information is important so we can create the lead and get it to the customer
    - `email` string
  - `product` object, required: Details about the product for the lead.
    - `brand` string
    - `imageUrl` string
    - `listPrice` object, required
      - `amount` number, required
      - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
      - `formattedAmount` string
    - `manufacturerWarrantyLengthLabor` number, required
    - `manufacturerWarrantyLengthParts` number, required
    - `purchasePrice` object, required
      - `amount` number, required: Amount, expressed in terms of the smallest currency unit: <ul><li>$19.99 would be 1999</li> <li>1.234,56 € would be 123456</li> <li>£ 1,999.99 would be 199999</li></ul>
      - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD': This is an ISO-4217 currency code. See https://en.wikipedia.org/wiki/ISO_4217 for more information
      - `formattedAmount` string
    - `referenceId` string, required
    - `serialNumber` string
    - `title` string, required
    - `transactionDate` number, required
    - `transactionId` string, required
    - `fulfillmentDate` number: The date when the product was fulfilled/shipped. If provided, this will be used instead of transactionDate for calculating lead expiration.
  - `quantity` number: The amount of line items purchased
  - `sellerId` string, required

## Response `201`

Created

- object
  - `createdAt` number, required
  - `customer` object: Details about the customer to create the lead for. This information is important so we can create the lead and get it to the customer
    - `email` string
  - `leadToken` string, required
  - `product` object, required: Details about the product for the lead.
    - `brand` string
    - `imageUrl` string
    - `listPrice` object, required
      - `amount` number, required
      - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'
      - `formattedAmount` string
    - `manufacturerWarrantyLengthLabor` number, required
    - `manufacturerWarrantyLengthParts` number, required
    - `purchasePrice` object, required
      - `amount` number, required: Amount, expressed in terms of the smallest currency unit: <ul><li>$19.99 would be 1999</li> <li>1.234,56 € would be 123456</li> <li>£ 1,999.99 would be 199999</li></ul>
      - `currencyCode` 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD': This is an ISO-4217 currency code. See https://en.wikipedia.org/wiki/ISO_4217 for more information
      - `formattedAmount` string
    - `referenceId` string, required
    - `serialNumber` string
    - `title` string, required
    - `transactionDate` number, required
    - `transactionId` string, required
    - `fulfillmentDate` number: The date when the product was fulfilled/shipped. If provided, this will be used instead of transactionDate for calculating lead expiration.
  - `quantity` number, required: The amount of line items purchased
  - `quantityConsumed` number, required
  - `sellerId` string, required
  - `updatedAt` number, required
  - `status` 'live' | 'consumed' | 'expired', required
  - `expirationDate` number

## Other responses

- `400`: The request to the endpoint was invalid
- `404`: Could not find an offer for the given product
- `500`: Internal server error

## Changes

- **2026-11-03** `9a33b8604511`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/extend/apis/leads-api/changes/leads/post.md)

---

[API](https://skmtc.dev/extend/apis/leads-api.md) - [All operations](https://skmtc.dev/extend/apis/leads-api/llms.txt) - [OpenAPI document](https://skmtc.dev/extend/apis/leads-api/revisions/9a33b8604511?raw)