---
title: "OpptyProductRelationRevenueSchedules.update"
method: PATCH
path: "/entities/OpptyProductRelationRevenueSchedules/{id}"
tags: ["Lead & Opportunity"]
---

# OpptyProductRelationRevenueSchedules.update

`PATCH /entities/OpptyProductRelationRevenueSchedules/{id}`

Modifies OpptyProductRelationRevenueSchedule or OpptyProductRelationRevenueSchedules with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateOpptyProductRelationRevenueScheduleInput
  - `is_deleted` boolean — Specifies if the entity is considered deleted.
  - `cancelation_date` string, date — Date when the revenue schedule was cancelled. Empty for active schedules.
  - `period_count` integer — Number of periods the line-item amount is split into.
  - `period_type` 1 | 2 | 3 — Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year
  - `start_date` string, date — Date when revenue recognition for this product line begins.
  - `revision` integer — Revision when entity was lastly changed.

## Response `200`

Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedule

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OpptyProductRelationRevenueSchedule
    - `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. Must match with OpptyProductRelation id.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `cancelation_date` string, date — Date when the revenue schedule was cancelled. Empty for active schedules.
    - `period_count` integer — Number of periods the line-item amount is split into.
    - `period_type` 1 | 2 | 3 — Length of each period (e.g. Monthly, Quarterly, Yearly). Integer enum value: 1 - Month, 2 - Quarter, 3 - Year
    - `start_date` string, date — Date when revenue recognition for this product line begins.
    - `revision` integer — Revision when entity was lastly changed.
    - `periods` string[] — Periods produced by this revenue schedule, ordered by date.

## 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/versions/e8c12ae60aca/schema)