Request A lead to create or change. Send only what you have; custom fields go inside fields.
name string or null Optional
phone string or null Optional
Indian numbers in any common shape: 9876543210, +91 98765 43210.
email string or null Optional
external_id string or null Optional
Your id for the person (customer no., loan no., employee id) — the best key to upsert on.
company string or null Optional
city string or null Optional
stage_id string or null Optional
pipeline_id string or null Optional
From GET /crm/pipelines; without stage_id the lead goes to that pipeline’s first stage.
owner_user_id string or null Optional
tags list of strings or null Optional
score integer or null Optional 0-100
score_label enum or null Optional
Allowed values: hot warm cold
expected_close_at string or null Optional
probability integer or null Optional 0-100
lost_reason string or null Optional
next_action_at string or null Optional
consent object or null Optional
fields object or null Optional
Custom fields by key or by label, in any case (GET /crm/fields lists them): {“Zone”: “Madhapur”}.
source string or null Optional
On create only: a short lower-case word (default “api”).
source_detail object or null Optional
On create only, e.g. {“form”: “Contact us”}.
on_conflict enum or null Optional
When the person is already a lead: error (default, 409), update, or ignore.
Allowed values: error update ignore
match_on list of enums or null Optional
What makes two leads the same person (default all three, in that order).
Allowed values: external_id phone email
create_missing_fields boolean or null Optional
Custom field names that don't exist become text fields instead of a 400.
Response Successful Response
name string or null Optional
phone string or null Optional
email string or null Optional
external_id string or null Optional
company string or null Optional
city string or null Optional
source string or null Optional
stage object or null Optional
pipeline_id string or null Optional
owner_user_id string or null Optional
tags list of strings Optional Defaults to []
score integer or null Optional
score_label string or null Optional
fields object Optional Defaults to {}
consent object Optional Defaults to {}
deal_value double or null Optional
last_call_at string or null Optional
last_call_outcome string or null Optional
created_at string or null Optional
updated_at string or null Optional
