Salesforce Contracts

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Contracts
Salesforce Contracts Standard Objects
Apex Reference
Salesforce Contracts Resources
REST Reference
Resources
Clause Library Resources
CLM Resources
Content Link Load (POST)
Check In Contract Document Version
Check Out Contract Document Version
Content Document Details (GET, DELETE, PATCH)
Contracts (PATCH, POST)
Contract Actions
Contract Document Version Template
Details of Contract Document Versions
Document Generation Process
Document Template
List of Contract Actions
Lock Document Version
Unlock Document Version
Context Mapping Extraction Resources
Customer Community Resources
Design Document Template Resources
External Document Resources
E-signature Resources
Request Bodies
Response Bodies
Salesforce Contracts Metadata API Types
PDF

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
/connect/clm/contract/${contractId}
Available version
56.0
HTTP methods
PATCH
Example for PATCH
https://yourInstance.salesforce.com/services/data/v56.0/clm/contract/${contractId}
Request body for PATCH
JSON example
{
    "actionApiName" : "updateEnvelopeStatus",
...."actionId" : //object state action definition id,
    "actionData":{
        "isUpdateEnvelopeStatusSuccess": true
    }
}
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.

Note

 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