Rpipedrive (version 0.1.1)

organizationrelationships.update: Update an organization relationship

Description

Function to Update an organization relationship on pipedrive.

Usage

organizationrelationships.update(id, org_id = NULL, type = NULL,
  rel_owner_org_id = NULL, rel_linked_org_id = NULL,
  api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

id

ID of the organization relationship

org_id

ID of the base organization for the returned calculated values

type

The type of organization relationship. This field has the following domains: (parent; related)

rel_owner_org_id

The owner of this relationship. If type is 'parent', then the owner is the parent and the linked organization is the daughter.

rel_linked_org_id

The linked organization in this relationship. If type is 'parent', then the linked organization is the daughter.

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