Sign in
partner-api

Create a lead

Create a new lead tagged to the calling partner. Upserts on contact_email — returns existing lead if already created by this partner.

post/api/partner/leads

Request body

contact_namestring required

Full name of the lead's primary contact.

contact_emailstring required

Contact email. Used as the upsert key — a repeated email returns the existing lead.

company_namestring required

Legal or trading name of the lead's company.

phonestring nullable

Contact phone number in E.164 or local format.

industrystring nullable

Industry or sector of the company.

notesstring nullable

Free-form internal notes about the lead.

Example request

{
  "company_name": "Acme Corp",
  "contact_email": "jane@acmecorp.com",
  "contact_name": "Jane Smith",
  "industry": "SaaS",
  "notes": "Referred via SIVO onboarding flow",
  "phone": "+1-555-0100"
}

Response

Successful Response

successboolean

Example response

{
  "success": true,
  "data": {
    "lead_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "contact_name": "Jane Smith",
    "contact_email": "jane@acmecorp.com",
    "company_name": "Acme Corp",
    "stage": "Prequalified",
    "created_at": "2026-06-12T10:00:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.