Leads
Create Lead
Create a lead. 409 (with `existing_id`) if a lead with the same email exists.
API key access
Needs the
leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.POST
/api/v1/leadsAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
first_name?string | null
Length
length <= 100last_name?string | null
Length
length <= 100title?string | null
Length
length <= 200email?string | null
Length
length <= 320phone?string | null
E.164 with country code
Length
length <= 32linkedin_url?string | null
Length
length <= 500timezone?string | null
Length
length <= 64language?string | null
Spoken language (RO-253): a code such as hi or pt-BR (normalised: hi_in -> hi-IN) or a common language name (Hindi -> hi); voice calls start in it
Length
length <= 35company_id?string | null
Format
uuidowner_id?string | null
A user who is a member of the workspace
Format
uuidphone_type?PhoneType
Default
"unknown"status?LeadStatus
Default
"new"source?string
Default
"manual"Length
length <= 64custom_fields?object
Empty Object
Response Body
curl -X POST "http://localhost:8000/api/v1/leads" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"first_name": "string",
"last_name": "string",
"title": "string",
"email": "string",
"phone": "string",
"phone_type": "mobile",
"linkedin_url": "string",
"timezone": "string",
"language": "string",
"status": "new",
"source": "string",
"custom_fields": {
"property1": null,
"property2": null
},
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"company": {},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}