Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 2.83 KB

NewDealParameters.md

File metadata and controls

21 lines (18 loc) · 2.83 KB

# NewDealParameters

Properties

Name Type Description Notes
value string The value of the deal. If omitted, value will be set to 0. [optional]
label int[] The array of the labels IDs. [optional]
currency string The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user. [optional]
user_id int The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. [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. This property is required unless `org_id` is specified. [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. This property is required unless `person_id` is specified. [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`. If omitted, the deal will be placed in the first stage of the default pipeline. [optional]
status string open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. [optional]
origin_id string The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. [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. You can fetch allowed values 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>. If omitted, channel will be set to null. [optional]
channel_id string The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. [optional]
add_time string The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS [optional]

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