Rpipedrive (version 0.1.1)

activities.update: Edit an activity

Description

Function to Edit an activity on pipedrive.

Usage

activities.update(id, subject = NULL, done = NULL, type = NULL,
  due_date = NULL, due_time = NULL, duration = NULL,
  user_id = NULL, deal_id = NULL, person_id = NULL,
  participants = NULL, org_id = NULL, note = NULL,
  api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

id

ID of the activity

subject

Subject of the activity. When omitted, will remain unchanged.

done

Whether the activity is done or not. 0 = Not done, 1 = Done This field has the following domains: (0; 1)

type

Type of the activity. This is in correlation with the key_string parameter of ActivityTypes.

due_date

Due date of the activity. Format: YYYY-MM-DD

due_time

Due time of the activity in UTC. Format: HH:MM

duration

Duration of the activity. Format: HH:MM

user_id

ID of the user whom the activity will be assigned to

deal_id

ID of the deal this activity will be associated with

person_id

ID of the person this activity will be associated with

participants

List of multiple persons (participants) this activity will be associated with. If omitted, single participant from person_id field is used. It requires a structure as follows: [person_id:1,primary_flag:true] this field must be a JSON.

org_id

ID of the organization this activity will be associated with

note

Note of the activity (HTML format). When omitted, will remain unchanged.

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