Initiate Upgrade Input

Input representation of the details of the request to initiate an upgrade action. The response includes the ID of the sales transaction that the upgrade action creates.

JSON Example

1{
2  "swapStartDate": "2025-12-01T00:00:00Z",
3  "outputRecordType": "Quote",
4  "swapGroups": {
5    "groups": [
6      {
7        "referenceId": "UPGRADE-001",
8        "outGroup": {
9          "swapAssets": [
10            {
11              "assetId": "02ixx0000004HOAAA2",
12              "quantity": 1
13            }
14          ]
15        },
16        "inGroup": {
17          "graphId": "upgradeRequest",
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": "2026-03-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 upgrade.	Optional	66.0
`opportunityId`	String	ID of the opportunity record to upgrade.	Optional	66.0
`outputRecordType`	String	Record type of the output for the upgrade.	Required	66.0
`swapGroups`	Swap Group[]	Groups that contain the asset details for the upgrade.	Required	66.0
`swapStartDate`	String	Amendment start date for the upgrade action.	Required	66.0