Initiate Amendment Action

Initiate and execute the amendment of an asset.

Specify the IDs of assets to amend, the amendment start date, and any quantity changes. You can choose whether the action creates an amendment quote or order.

Considerations

For usage products, creating an order directly by setting amendOutputType to Order is currently not supported. The direct-to-order flow can create Order Products without required related Rate Card Entry records, which can cause order activation to fail.

When you amend usage assets, use a two-step flow.

Create an amendment quote by calling initiateAmendment with amendOutputType set to Quote.
Create an order from that amendment quote.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/initiateAmendment

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`amendAssetIds`	string	Required. The IDs of the assets that you want to amend.
`amendContractId`	string	The ID of the contract record to be synced with the amendment.
`amendStartDate`	datetime	Required. Effective start date of the amendment.
`amendOpportunityId`	string	The ID of the Opportunity record to be synced with the amendment quote.
`amendOutputType`	string	Required. Type of amendment record to create such as a quote or an order. For usage products, set this value to `Quote`. The usage-related records (`QuoteLineItemUseResourceGrant`, `QuoteLineItemUsageResourcePolicy`, and `QuoteLineRateCardEntry`) are copied in the quote action flow, not in the amend order flow.
`quantityChange`	double	Required. Quantity to add to or reduce from the asset’s existing quantity.
`skipPricing`	boolean	Indicates whether the pricing procedure must be skipped (`true`) or performed (`false`). Available in API version 64.0 and later.

Outputs

Output	Type	Description
`amendRecordId`	string	The ID of the amendment record that’s created.
`requestIdentifier`	string	Request ID that’s used to track the async request.

Example

POST

This sample request is for the Initiate Amendment action.

1{
2    "inputs": [
3        {
4            "amendAssetIds": ["02iI8000000HPzXIAW"],
5            "amendStartDate": "2023-10-21T00:00:00.000Z",
6            "quantityChange": 5,
7            "amendOutputType": "Quote",
8            "amendContractId": "800DU0000000lZlYAI",
9            "amendOpportunityId": "006DU0000025AanYAE",
10            "skipPricing": false
11        }
12    ]
13}

This sample response is for the Initiate Amendment action.

1[
2    {
3        "actionName": "initiateAmendment",
4        "errors": null,
5        "isSuccess": true,
6        "outputValues": {
7            "record_id": "0Q0xx0000004NsSCAU",
8            "requestIdentifier": "16Pxx0000004NIy"
9        },
10        "version": 1
11    }
12]