Rpipedrive (version 0.1.1)

personfields.update: Update a person field

Description

Function to Update a person field on pipedrive.

Usage

personfields.update(id, name, options = NULL, api_token = NULL,
  company_domain = "api", return_type = c("complete", "boolean"))

Arguments

id

ID of the field to update.

name

Name of the field

options

When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: [id:123,label:Existing Item,label:New Item] this field must be a JSON.

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 {
personfields.update(id='e.g.',name='e.g.',api_token='token',company_domain='exp')
# }