Add a deal
POST {{baseUrl}}/deals
Adds a new deal. All deals created through the Pipedrive API will have a origin set to API. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for key values. For more information, see the tutorial for adding a deal.
Request Body
{"title"=>"<string>", "value"=>"<string>", "label"=>["<integer>", "<integer>"], "currency"=>"<string>", "user_id"=>"<integer>", "person_id"=>"<integer>", "org_id"=>"<integer>", "pipeline_id"=>"<integer>", "stage_id"=>"<integer>", "status"=>"<string>", "origin_id"=>"<string>", "channel"=>"<integer>", "channel_id"=>"<string>", "add_time"=>"<string>", "won_time"=>"<string>", "lost_time"=>"<string>", "close_time"=>"<string>", "expected_close_date"=>"<date>", "probability"=>"<number>", "lost_reason"=>"<string>", "visible_to"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"success":true,"data":{"id":1,"creator_user_id":{"id":8877,"name":"Creator","email":"john.doe@pipedrive.com","has_pic":false,"pic_hash":null,"active_flag":true,"value":8877},"user_id":{"id":8877,"name":"Creator","email":"john.doe@pipedrive.com","has_pic":false,"pic_hash":null,"active_flag":true,"value":8877},"person_id":{"active_flag":true,"name":"Person","email":[{"label":"work","value":"person@pipedrive.com","primary":true}],"phone":[{"label":"work","value":"37244499911","primary":true}],"value":1101},"org_id":{"name":"Organization","people_count":2,"owner_id":8877,"address":"","active_flag":true,"cc_email":"org@pipedrivemail.com","value":5},"stage_id":2,"title":"Deal One","value":5000,"currency":"EUR","add_time":"2019-05-29 04:21:51","update_time":"2019-11-28 16:19:50","stage_change_time":"2019-11-28 15:41:22","active":true,"deleted":false,"status":"open","probability":null,"next_activity_date":"2019-11-29","next_activity_time":"11:30:00","next_activity_id":128,"last_activity_id":null,"last_activity_date":null,"lost_reason":null,"visible_to":"1","close_time":null,"pipeline_id":1,"won_time":"2019-11-27 11:40:36","first_won_time":"2019-11-27 11:40:36","lost_time":"","products_count":0,"files_count":0,"notes_count":2,"followers_count":0,"email_messages_count":4,"activities_count":1,"done_activities_count":0,"undone_activities_count":1,"participants_count":1,"expected_close_date":"2019-06-29","last_incoming_mail_time":"2019-05-29 18:21:42","last_outgoing_mail_time":"2019-05-30 03:45:35","label":"11","origin":"API","origin_id":"Zapier","channel":16,"channel_id":null,"stage_order_nr":2,"person_name":"Person","org_name":"Organization","next_activity_subject":"Call","next_activity_type":"call","next_activity_duration":"00:30:00","next_activity_note":"Note content","formatted_value":"€5,000","weighted_value":5000,"formatted_weighted_value":"€5,000","weighted_value_currency":"EUR","rotten_time":null,"owner_name":"Creator","cc_email":"company+deal1@pipedrivemail.com","org_hidden":false,"person_hidden":false,"acv":null,"arr":null,"mrr":null,"acv_currency":null,"arr_currency":null,"mrr_currency":null},"related_objects":{"user":{"8877":{"id":8877,"name":"Creator","email":"john.doe@pipedrive.com","has_pic":false,"pic_hash":null,"active_flag":true}},"organization":{"2":{"id":2,"name":"Organization","people_count":2,"owner_id":8877,"address":"Mustamäe tee 3a, 10615 Tallinn","active_flag":true,"cc_email":"org@pipedrivemail.com"}},"person":{"1101":{"active_flag":true,"id":1101,"name":"Person","email":[{"label":"work","value":"person@pipedrive.com","primary":true}],"phone":[{"label":"work","value":"3421787767","primary":true}],"owner_id":8877}},"stage":{"2":{"id":2,"company_id":123,"order_nr":1,"name":"Stage Name","active_flag":true,"deal_probability":100,"pipeline_id":1,"rotten_flag":false,"rotten_days":null,"add_time":"2015-12-08 13:54:06","update_time":"2015-12-08 13:54:06","pipeline_name":"Pipeline","pipeline_deal_probability":true}},"pipeline":{"1":{"id":1,"name":"Pipeline","url_title":"Pipeline","order_nr":0,"active":true,"deal_probability":true,"add_time":"2015-12-08 10:00:24","update_time":"2015-12-08 10:00:24"}}}}