---
title: "OpptyProductRelations.update"
method: PATCH
path: "/entities/OpptyProductRelations/{id}"
tags: ["Product Line Items"]
---

# OpptyProductRelations.update

`PATCH /entities/OpptyProductRelations/{id}`

Modifies OpptyProductRelation or OpptyProductRelations with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateOpptyProductRelationInput
  - `paired_oppty_product_relation` object — Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties.
    - `id` string, uri
  - `amount` number, double — Total amount of the line item (price * quantity, with discounts applied).
  - `comment` string — Free-form note describing this line item.
  - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list.
  - `online_form_field_id` string, uuid — Id of the online form field.
  - `online_form_id` string, uuid — Id of the online form.
  - `oppty_id` string, uuid — Id of the opportunity.
  - `oppty_product_relation_type_id` string, uuid — Id of the line-item type.
  - `paired_oppty_product_relation_id` string, uuid — Id of the paired line item.
  - `price` number, double — Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
  - `quantity` number, double — Number of product units on this line item.
  - `quote_id` string, uuid — Id of the quote.
  - `section_id` string, uuid — Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote).
  - `sort_order` integer — Display order of the line item within its section. Maintained automatically when lines are added or moved.
  - `revision` integer — Revision when entity was lastly changed.
  - `revenue_schedule` object — Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Relation to OpptyProductRelationRevenueSchedule, see: 'updateOpptyProductRelationRevenueScheduleInput' object for properties.
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting OpptyProductRelation

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OpptyProductRelation
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `currency_exchange_rates_list` string, uri — Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.
    - `online_form_field` string, uri — Online form field that produced this line item, or empty when not applicable. Relation to Field. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Field' object for properties.
    - `online_form` string, uri — Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties.
    - `oppty` string, uri — Opportunity this line item belongs to. Set on create; mutually exclusive with quote. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `oppty_product_relation_type` string, uri, required — Line-item type that drives the form layout for this product line. Resolved from the product type on create. Relation to OpptyProductRelationType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationType' object for properties.
    - `paired_oppty_product_relation` string, uri — Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelation' object for properties.
    - `product` string, uri, required — Product on this line item. Set on create; cannot be changed afterwards. Relation to Product. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Product' object for properties.
    - `quote` string, uri — Quote this line item belongs to. Mutually exclusive with oppty. Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.
    - `amount` number, double — Total amount of the line item (price * quantity, with discounts applied).
    - `comment` string — Free-form note describing this line item.
    - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list.
    - `online_form_field_id` string, uuid — Id of the online form field.
    - `online_form_id` string, uuid — Id of the online form.
    - `oppty_id` string, uuid — Id of the opportunity.
    - `oppty_product_relation_type_id` string, uuid — Id of the line-item type.
    - `paired_oppty_product_relation_id` string, uuid — Id of the paired line item.
    - `price` number, double — Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
    - `product_id` string, uuid, required — Id of the product.
    - `quantity` number, double — Number of product units on this line item.
    - `quote_id` string, uuid — Id of the quote.
    - `section_id` string, uuid — Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote).
    - `sort_order` integer — Display order of the line item within its section. Maintained automatically when lines are added or moved.
    - `revision` integer — Revision when entity was lastly changed.
    - `revenue_schedule` string, uri — Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Relation to OpptyProductRelationRevenueSchedule. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpptyProductRelationRevenueSchedule' object for properties.
    - `discount_value` number, double — Absolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
    - `discount_percentage` number, double — Percentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
    - `modified_by_user` string, date-time — Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)