Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 3.53 KB

AddLeadRequest.md

File metadata and controls

20 lines (17 loc) · 3.53 KB

# AddLeadRequest

Properties

Name Type Description Notes
title string The name of the lead
owner_id int 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. [optional]
label_ids string[] The IDs of the lead labels which will be associated with the lead [optional]
person_id int 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 `organization_id` is specified. [optional]
organization_id int 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 `person_id` is specified. [optional]
value \Pipedrive\Model\LeadValue [optional]
expected_close_date \DateTime 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. [optional]
visible_to VisibleTo 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 <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]
was_seen bool A flag indicating whether the lead was seen by someone in the Pipedrive UI [optional]
origin_id string The optional ID to further distinguish the origin of the lead - e.g. Which API integration created this lead. If omitted, `origin_id` will be set to null. [optional]
channel int 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 <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]

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