POST /leads
Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source and origin set to API. Here's the tutorial for adding a lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the updating custom fields' values tutorial.
Servers
- https://api.pipedrive.com/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
person_id |
Integer | No |
The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless |
||||||||||||||||
visible_to |
String | No |
The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups here. Essential / Advanced plan
Professional / Enterprise plan
Possible values:
|
||||||||||||||||
was_seen |
Boolean | No |
A flag indicating whether the lead was seen by someone in the Pipedrive UI |
||||||||||||||||
channel |
Integer | No |
The ID of Marketing channel this lead was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with GET /v1/dealFields. If omitted, channel will be set to null. |
||||||||||||||||
channel_id |
String | No |
The optional ID to further distinguish the Marketing channel. If omitted, |
||||||||||||||||
origin_id |
String | No |
The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this lead. If omitted, |
||||||||||||||||
title |
String | Yes |
The name of the lead |
||||||||||||||||
label_ids[] |
Array | No |
The IDs of the lead labels which will be associated with the lead |
||||||||||||||||
value |
Object | No |
The potential value of the lead represented by a JSON object: |
||||||||||||||||
value.amount |
Number | Yes | |||||||||||||||||
value.currency |
String | Yes | |||||||||||||||||
organization_id |
Integer | No |
The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless |
||||||||||||||||
expected_close_date |
String | No |
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. |
||||||||||||||||
owner_id |
Integer | No |
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.