Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 4.4 KB

NewPerson.md

File metadata and controls

18 lines (14 loc) · 4.4 KB

Pipedrive.NewPerson

Properties

Name Type Description Notes
name String The name of the person
owner_id Number The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used. [optional]
org_id Number The ID of the organization this person will belong to [optional]
email [BasicPersonEmail] An email address as a string or an array of email objects related to the person. The structure of the array is as follows: `[{ "value": "mail@example.com", "primary": "true", "label": "main" }]`. Please note that only `value` is required. [optional]
phone [BasePersonItemPhone] A phone number supplied as a string or an array of phone objects related to the person. The structure of the array is as follows: `[{ "value": "12345", "primary": "true", "label": "mobile" }]`. Please note that only `value` is required. [optional]
label Number The label assigned to the person. When the `label` field is updated, the `label_ids` field value will be overwritten by the `label` field value. [optional]
label_ids [Number] The IDs of labels assigned to the person. When the `label_ids` field is updated, the `label` field value will be set to the first value of the `label_ids` field. [optional]
visible_to VisibleTo The visibility of the person. 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]
marketing_status MarketingStatus If the person does not have a valid email address, then the marketing status is not set and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed once to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> [optional]
add_time String The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS [optional]