LeadSalesHub
Talk to us Sign up

Getting Started

This guide takes you from nothing to a lead posted and distributed.

What you need

  • A seller campaign key. We issue this when your campaign is set up. It identifies your campaign and authenticates your posts.
  • A vertical. Every campaign belongs to exactly one — it determines which buyers are eligible and which fields are required.

Post a lead

POST /api/v1/lead
Content-Type: application/json

{
  "SELLER_CAMPAIGN_KEY": "your-campaign-key",
  "first_name": "Jane",
  "last_name": "Doe",
  "email_address": "jane@example.com",
  "phone_home": "5551234567",
  "state": "TX",
  "zip": "78701"
}

The legacy form POST /{seller_campaign_key} is also supported and will not be removed.

What happens next

  1. Authentication — the campaign key is matched to an active campaign.
  2. Validation — fields are checked against the vertical's requirements.
  3. Matching — active contracts for your campaign and vertical are collected and ordered by the campaign's distribution type.
  4. Filtering — each buyer's filters and remaining capacity are evaluated.
  5. Delivery — buyers are tried in priority order until one accepts.
  6. Recording — the outcome is written, including which buyer bought it and at what price.

Reading the response

A 200 means the lead was processed. The body tells you whether it sold and for how much. A 202 means it was queued for asynchronous processing and carries a job identifier.

A lead that doesn't sell is not an error. Common reasons: every eligible buyer filtered it out, capacity was exhausted, or it was inside a duplicate window.

Next steps