Rpipedrive (version 0.1.1)

persons.add: Add a person

Description

Function to Add a person on pipedrive.

Usage

persons.add(name, owner_id = NULL, org_id = NULL, email = NULL,
  phone = NULL, visible_to = NULL, add_time = NULL,
  customList = NULL, api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

name

Person name

owner_id

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

org_id

ID of the organization this person will belong to.

email

Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person.

phone

Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person.

visible_to

Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.1 = Owner & followers (private); 3 = Entire company (shared) This field has the following domains: (1; 3)

add_time

Optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

customList

List with custom fields. Example: list(`custom_field` = abc)

api_token

To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>

company_domain

How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>

return_type

the default return is an object List with all informations of process, or you can set boolean (TRUE = success, FALSE = error)

Value

customizable return, the default is an object List

Examples

# NOT RUN {
persons.add(name='e.g.',api_token='token',company_domain='exp')
# }