Rpipedrive (version 0.1.1)

stages.update: Update stage details

Description

Function to Update stage details on pipedrive.

Usage

stages.update(id, name = NULL, pipeline_id = NULL, order_nr = NULL,
  deal_probability = NULL, rotten_flag = NULL, rotten_days = NULL,
  api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

id

ID of the stage

name

Name of the stage

pipeline_id

ID of the pipeline this stage belongs to.

order_nr

An order number for this stage. Order numbers should be used to order the stages in the pipeline.

deal_probability

Deal success probability percentage. Used/shown when deal weighted values are used.

rotten_flag

Whether deals in this stage can become rotten. This field has the following domains: (0; 1)

rotten_days

Number of days the deals not updated in this stage would become rotten. Applies only if rotten_flag is set.

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