Contract Actions

Execute possible actions for a contract based on the status. Actions can trigger work flows and change the status for a contract.

Resource

1/connect/clm/contract/$CONTRACT_ID

Available Version

56.0

HTTP Methods

PATCH

Example for PATCH

1https://YOUR_INSTANCE.salesforce.com/services/data/v56.0/clm/contract/${contractId}

Request Body for PATCH

JSON Example

1{
2    "actionApiName" : "updateEnvelopeStatus",
3...."actionId" : //object state action definition id,
4    "actionData":{
5        "isUpdateEnvelopeStatusSuccess": true
6    }
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`actionApiName`	String	API name for respective contract action.	Optional	57.0
`actionId`	String	ID for Object state Action Definition record. For the list of all standard actions supported, refer Predefined Dynamic (Contract) Actions.	Optional	57.0
`actionData`	Map<String, String>	Action body with supported format string.	Optional	57.0

For any request, either actionApiName or actionId must be passed. If none passed, the application raises an exception.

Note

Response Body for PATCH

Generic Output Representation