Create Lead | BookedIn Documentation

curl -X POST https://api.bookedin.ai/api/v1/leads \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "contact": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "john@example.com",
    "number": "+15551234567",
    "timezone": "America/New_York"
  },
  "source": "API",
  "meta": {
    "company": "Acme Corp",
    "role": "CTO",
    "interest": "Enterprise plan"
  }
}'

{
  "id": "lead_xyz789",
  "business_id": "string",
  "contact": {
    "name": {
      "first": "John",
      "last": "Smith"
    },
    "email": "john@example.com",
    "number": "+15551234567",
    "timezone": "America/New_York"
  },
  "source": "API",
  "meta": {
    "company": "Acme Corp",
    "industry": "Technology",
    "employees": 50
  },
  "data": {
    "objective_met": false,
    "history_summary": "No history summary yet",
    "lead_score": 1,
    "can_followup": true
  },
  "pipeline_id": "string",
  "pipeline_stage": {
    "current_stage": "string",
    "current_stage_name": "string",
    "entered_at": "2024-01-15T09:30:00Z"
  },
  "created_at": "2024-01-15T09:30:00Z"
}

Create a new lead. Email and phone must be unique within your business.

Authentication

X-API-Keystring

Your API key from Dashboard → Settings → API Keys

Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Request

This endpoint expects an object.

contactobjectOptional

Lead contact information

sourceenumOptionalDefaults to API

metamap from strings to anyOptional

Custom metadata fields

pipeline_idstringOptional

Assign lead to a pipeline

list_idstringOptional

Assign lead to a list

Response

Lead created

idstringOptional

Unique lead identifier

business_idstringOptional

Business this lead belongs to

contactobjectOptional

Lead contact information

sourceenumOptional

How this lead was created

metamap from strings to anyOptional

Custom metadata fields. Store any additional data about the lead.

dataobjectOptional

Lead status and scoring data

pipeline_idstringOptional

Pipeline this lead is assigned to

pipeline_stageobjectOptional

Current pipeline stage information

created_atdatetimeOptional

Errors

400

Bad Request Error