PUT /persons/{id}

Updates the properties of a person. For more information, see the tutorial for updating a person.
If a company uses the Campaigns product, then this endpoint will also accept and return the data.marketing_status field.

Servers

https://api.pipedrive.com/v1

Path parameters

Name	Type	Required	Description
`id`	Integer	Yes	The ID of the person

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name Type Required Description

visible_to

String

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 here.

Essential / Advanced plan

Value	Description
`1`	Owner & followers
`3`	Entire company

Professional / Enterprise plan

Value	Description
`1`	Owner only
`3`	Owner's visibility group
`5`	Owner's visibility group and sub-groups
`7`	Entire company

Possible values:

"3"
"1"
"7"
"5"

name

String

The name of the person

email[]

Array

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.

email[].label

String

The label that indicates the type of the email. (Possible values - work, home or other)

email[].value

String

The email

email[].primary

Boolean

Boolean that indicates if email is primary for the person or not

label

Integer

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.

add_time

String

The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS

phone[]

Array

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.

phone[].label

String

The label that indicates the type of the phone number. (Possible values - work, home, mobile or other)

phone[].value

String

The phone number

phone[].primary

Boolean

Boolean that indicates if phone number is primary for the person or not

label_ids[]

Array

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.

org_id

Integer

The ID of the organization this person will belong to

marketing_status

String

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.

Value	Description
`no_consent`	The customer has not given consent to receive any marketing communications
`unsubscribed`	The customers have unsubscribed from ALL marketing communications
`subscribed`	The customers are subscribed and are counted towards marketing caps
`archived`	The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for

Possible values:

"subscribed"
"unsubscribed"
"archived"
"no_consent"

owner_id

Integer

The ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.