Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 4.43 KB

UpdateDealRequest.md

File metadata and controls

27 lines (24 loc) · 4.43 KB

# UpdateDealRequest

Properties

Name Type Description Notes
title string The title of the deal [optional]
value string The value of the deal. [optional]
label int[] Array of the deal labels IDs. [optional]
currency string The currency of the deal. Accepts a 3-character currency code. [optional]
user_id int The ID of the user which will be the new owner of the deal. [optional]
person_id int The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. [optional]
org_id int The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. [optional]
pipeline_id int The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. [optional]
stage_id int The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. [optional]
status string open = Open, won = Won, lost = Lost, deleted = Deleted. [optional]
channel int The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company which you can fetch with <a href=&quot;https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;>GET /v1/dealFields</a>. [optional]
channel_id string The optional ID to further distinguish the Marketing channel. [optional]
won_time string The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. [optional]
lost_time string The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. [optional]
close_time string The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. [optional]
expected_close_date \DateTime The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. [optional]
probability float The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. [optional]
lost_reason string The optional message about why the deal was lost (to be used when status = lost) [optional]
visible_to VisibleTo The visibility of the deal. 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 <a href=&quot;https://support.pipedrive.com/en/article/visibility-groups\" target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;>here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=&quot;width:40px&quot;>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=&quot;width:40px&quot;>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> [optional]

[Back to Model list] [Back to API list] [Back to README]