Contract Amender API
Receive a CPQ contract ID in a request, and return quote data for an amendment quote.
| Required Editions |
|---|
| Available in: Salesforce CPQ Summer ’16 and later |
- Service Provider Name
SBQQ.ContractManipulationAPI.ContractAmender
- Formats
JSON, Apex
- HTTP Method
PATCH
- Authentication
Authorization: Bearer token
All of these user permissions are required.
-
Create on Opportunity
Without full access on Opportunity, an error results, and contract amendment fails.
-
Read on Quote, Opportunity, and Product2
-
Insert and update on Quote and Opportunity
-
Delete on Quote and Opportunity
- Parameter 1
Name: uid
Type: String
Required: Yes
Description: 15-character case sensitive or 18-character case insensitive Salesforce Contract ID to amend.
- Parameter 2
Available in: Salesforce CPQ Winter ’21 and later
Name: AmendmentContext
Type: AmendmentContext
Required: No
Description: Context for the contract to amend.
- Type
QuoteModel
- Description
Representation of SBQQ__Quote__c data for an amendment quote
An example response body after amending a quote. The actual response is a JSON formatted string.
An example response body after amending a quote. The actual response is a JSON formatted string.
Before saving the ContractAmender example class, make sure that the CPQ model classes are added as individual Apex classes in your org.
In this example, the amendment context isn’t used.
In this example, the amendment context is used.
Example response body for returnOnlyQuoteId = true: