Add a lead
POST {{baseUrl}}/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.
Request Body
{"title"=>"<string>", "owner_id"=>"<integer>", "label_ids"=>["<uuid>", "<uuid>"], "person_id"=>"<integer>", "organization_id"=>"<integer>", "value"=>{"amount"=>"<number>", "currency"=>"<string>"}, "expected_close_date"=>"<date>", "visible_to"=>"<string>", "was_seen"=>"<boolean>", "origin_id"=>"<string>", "channel"=>"<integer>", "channel_id"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"success":true,"data":{"id":"adf21080-0e10-11eb-879b-05d71fb426ec","title":"Jane Doe Lead","owner_id":1,"creator_id":1,"label_ids":["f08b42a0-4e75-11ea-9643-03698ef1cfd6","f08b42a1-4e75-11ea-9643-03698ef1cfd6"],"person_id":1092,"organization_id":null,"source_name":"API","origin":"API","origin_id":null,"channel":52,"channel_id":"Jun23 Billboards","is_archived":false,"was_seen":false,"value":{"amount":999,"currency":"USD"},"expected_close_date":null,"next_activity_id":1,"add_time":"2020-10-14T11:30:36.551Z","update_time":"2020-10-14T11:30:36.551Z","visible_to":"3","cc_email":"company+1+leadntPaYKA5QRxXkh6WMNHiGh@dev.pipedrivemail.com"}}