Initiate Downgrade Input

Input representation of the details of the request to initiate a downgrade action.

JSON Example

1{
2  "swapStartDate": "2025-12-01T00:00:00Z",
3  "outputRecordType": "Quote",
4  "swapGroups": {
5    "groups": [
6      {
7        "referenceId": "DOWNGRADE-001",
8        "outGroup": {
9          "swapAssets": [
10            {
11              "assetId": "02ixx0000004HOAAA2",
12              "quantity": 1
13            }
14          ]
15        },
16        "inGroup": {
17          "graphId": "downgradeRequest",
18          "records": [
19            {
20              "referenceId": "refQuoteLine0",
21              "record": {
22                "attributes": {
23                  "type": "QuoteLineItem",
24                  "method": "POST"
25                },
26                "Product2Id": "01txx0000006iVlAAI",
27                "PricebookEntryId": "01uxx0000008ym4AAA",
28                "UnitPrice": 1049,
29                "Quantity": "1",
30                "StartDate": "2022-09-22"
31              }
32            }
33          ]
34        }
35      }
36    ]
37  }
38}

Properties

Name	Type	Description	Required or Optional	Available Version
`contractId`	String	ID of the contract record to downgrade.	Optional	66.0
`opportunityId`	String	ID of the opportunity record to downgrade.	Optional	66.0
`outputRecordType`	String	Record type of the output for the downgrade.	Required	66.0
`swapGroups`	Swap Group[]	Groups that contain the asset details for the downgrade.	Required	66.0
`swapStartDate`	String	Amendment start date for the downgrade action.	Required	66.0