leads_create
Create a new lead in Pipedrive by providing a title and linking to a person or organization. Optionally add deal value, expected close date, and custom fields.
Instructions
Create a new lead in Pipedrive.
Creates a new lead with the specified information. A lead must be linked to a person or an organization (or both). All leads created through the API will have source_name "API" and origin "API".
Custom fields:
Pass display names: { "custom_fields": { "Source": "Web", "Budget": 5000 } }
Or hash keys directly: { "custom_fields": { "abc123...": "raw value" } }
Uses deal field definitions (leads share the deal custom fields).
Workflow tips:
Title is required
Must have person_id, organization_id, or both
Use persons/search or organizations/search to get IDs
Value is optional but recommended (object with amount and currency)
Leads inherit custom fields structure from deals
Set expected_close_date in YYYY-MM-DD format
label_ids is an array of UUID strings
Common use cases:
Simple lead: { "title": "New Lead", "person_id": 123 }
Lead with value: { "title": "Lead", "person_id": 123, "value": { "amount": 5000, "currency": "USD" } }
Lead with org: { "title": "Company Lead", "organization_id": 456 }
Full lead: { "title": "Big Lead", "person_id": 123, "organization_id": 456, "value": { "amount": 50000, "currency": "USD" }, "expected_close_date": "2024-12-31", "owner_id": 1 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Lead title (required) | |
| value | No | Lead value with amount and currency | |
| channel | No | Channel ID | |
| owner_id | No | ID of the user who will own this lead | |
| was_seen | No | Whether the lead was seen | |
| label_ids | No | Array of label UUIDs | |
| origin_id | No | Origin ID for tracking | |
| person_id | No | ID of the person this lead is associated with | |
| channel_id | No | Channel identifier string | |
| visible_to | No | Visibility: 1=Owner, 3=Owner's group, 5=Owner's group and sub-groups, 7=Entire company | |
| custom_fields | No | Custom field values keyed by display name or hash. Uses deal field definitions. | |
| organization_id | No | ID of the organization this lead is associated with | |
| expected_close_date | No | Expected close date in YYYY-MM-DD format |