deals.update.products: Update product attachment details of the deal-product (a...

Description Usage Arguments Value Examples

Description

Function to Update product attachment details of the deal-product (a product already attached to a deal) on pipedrive.

Usage

1
2
3
4
5
deals.update.products(id, deal_product_id, item_price, quantity,
  discount_percentage = NULL, duration = NULL,
  product_variation_id = NULL, comments = NULL, enabled_flag = NULL,
  api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

id

ID of the deal

deal_product_id

ID of the deal-product (the ID of the product attached to the deal)

item_price

Price at which this product will be added to the deal

quantity

Quantity e.g. how many items of this product will be added to the deal

discount_percentage

Discount percent

duration

Duration of the product

product_variation_id

ID of the product variation to use.

comments

Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

enabled_flag

Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. This field has the following domains: (0; 1)

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

1
deals.update.products(id='e.g.',deal_product_id='e.g.',item_price='e.g.',quantity='e.g.')

Rpipedrive documentation built on May 15, 2019, 1:06 a.m.