Initiate Amendment Action

Initiate the amendment of an asset.

This action is available in API version 60.0 and later.

Supported REST HTTP Methods

URI
/services/data/v64.0/actions/standard/initiateAmendment
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
amendAssetIds
Type
string
Description

Required.

The IDs of the assets that you want to amend.

amendContractId
Type
string
Description

The ID of the contract record to be synced with the amendment.

amendStartDate
Type
datetime
Description

Required.

Effective start date of the amendment.

amendOpportunityId
Type
string
Description

The ID of the Opportunity record to be synced with the amendment quote.

amendOutputType
Type
string
Description

Required.

Type of amendment record to create.

quantityChange
Type
double
Description

Required.

Quantity to add to or reduce from the asset's existing quantity.

skipPricing
Type
boolean
Description

Indicates whether the pricing procedure must be skipped (true) or performed (false). Available in API version 64.0 and later.

Outputs

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

Example

POST

This sample request is for the Initiate Amendment action.

{
    "inputs": [
        {
            "amendAssetIds": ["02iI8000000HPzXIAW"],
            "amendStartDate": "2023-10-21T00:00:00.000Z",
            "quantityChange": 5,
            "amendOutputType": "Quote",
            "amendContractId": "contract ID",
            "amendOpportunityId": "Opportunity ID",
            "skipPricing": false
        }
    ]
}

This sample response is for the Initiate Amendment action.

[
    {
        "actionName": "initiateAmendment",
        "errors": null,
        "isSuccess": true,
        "outputValues": {
            "record_id": "0Q0xx0000004NsSCAU",
            "requestIdentifier": "16Pxx0000004NIy"
        },
        "version": 1
    }
]