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/${contractId}

Available version

56.0

Requires Chatter

HTTP methods

PATCH

Example for PATCH

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

Request body for PATCH

JSON example

1{
2    "actionApiName" : "updateEnvelopeStatus",
3    "actionData":{
4        "isUpdateEnvelopeStatusSuccess": true
5    }
6}

Properties

Name	Type	Description	Required or Optional	Available Version
`actionApiName`	String	API name for respective contract action.	Required	56.0
`actionData`	Map<String, String>	Action body with supported format string.	Optional	56.0

Response body for PATCH

Generic Output Representation

Salesforce Contracts