Module persons_api

Module persons_api 

Source

Enums§

AddPersonError
struct for typed errors of method add_person
AddPersonFollowerError
struct for typed errors of method add_person_follower
AddPersonPictureError
struct for typed errors of method add_person_picture
DeletePersonError
struct for typed errors of method delete_person
DeletePersonFollowerError
struct for typed errors of method delete_person_follower
DeletePersonPictureError
struct for typed errors of method delete_person_picture
DeletePersonsError
struct for typed errors of method delete_persons
GetPersonActivitiesError
struct for typed errors of method get_person_activities
GetPersonDealsError
struct for typed errors of method get_person_deals
GetPersonError
struct for typed errors of method get_person
GetPersonFilesError
struct for typed errors of method get_person_files
GetPersonFollowersError
struct for typed errors of method get_person_followers
GetPersonMailMessagesError
struct for typed errors of method get_person_mail_messages
GetPersonProductsError
struct for typed errors of method get_person_products
GetPersonUpdatesError
struct for typed errors of method get_person_updates
GetPersonUsersError
struct for typed errors of method get_person_users
GetPersonsCollectionError
struct for typed errors of method get_persons_collection
GetPersonsError
struct for typed errors of method get_persons
MergePersonsError
struct for typed errors of method merge_persons
SearchPersonsError
struct for typed errors of method search_persons
UpdatePersonError
struct for typed errors of method update_person

Functions§

add_person
Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for key values.
If a company uses the Campaigns product, then this endpoint will also accept and return the data.marketing_status field.
add_person_follower
Adds a follower to a person.
add_person_picture
Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.
delete_person
Marks a person as deleted. After 30 days, the person will be permanently deleted.
delete_person_follower
Deletes a follower from a person.
delete_person_picture
Deletes a person’s picture.
delete_persons
Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
get_person
Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of personFields.
If a company uses the Campaigns product, then this endpoint will also return the data.marketing_status field.
get_person_activities
Lists activities associated with a person.
get_person_deals
Lists deals associated with a person.
get_person_files
Lists files associated with a person.
get_person_followers
Lists the followers of a person.
get_person_mail_messages
Lists mail messages associated with a person.
get_person_products
Lists products associated with a person.
get_person_updates
Lists updates about a person.
If a company uses the Campaigns product, then this endpoint’s response will also include updates for the marketing_status field.
get_person_users
List users permitted to access a person.
get_persons
Returns all persons.
get_persons_collection
Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href="https://support.pipedrive.com/en/article/global-user-management" target="_blank" rel="noopener noreferrer">here.
merge_persons
Merges a person with another person. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-persons" target="_blank" rel="noopener noreferrer">merging two persons.
search_persons
Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID.
update_person
Updates the properties of a person. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-a-person" target="_blank" rel="noopener noreferrer">updating a person.
If a company uses the Campaigns product, then this endpoint will also accept and return the data.marketing_status field.