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
Context Mapping Extraction Resources
Customer Community Resources
Design Document Template Resources
Document Templates (GET, PATCH, POST)
External Document Resources
E-signature Resources
Request Bodies
Response Bodies
Salesforce Contracts Metadata API Types
PDF

Document Templates (GET, PATCH, POST)

Access document template actions, including template creation with the Document Template Designer.
Resource
/connect/docgen/document-templates
GET Example
https://yourInstance.salesforce.com/services/data/v64.0/connect/docgen/document-templates?offset=${offset}&limit=${limit}&searchString=${searchString}
PATCH Example
https://yourInstance.salesforce.com/services/data/v64.0/connect/docgen/document-templates?documentTemplateId=${documentTemplateId}
POST Example
https://yourInstance.salesforce.com/services/data/v64.0/connect/docgen/document-templates?documentTemplateId=${documentTemplateId}&action=${action}
Available version
60.0
HTTP methods
GET, PATCH, POST
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
limit String Number of document templates per page. The default value is 20. Optional 60.0
offset String Number of records to skip. The default value is 0. Optional 60.0
searchString String Search term that is used to retrieve a list of document templates. Optional 60.0
Response body for GET
Document Template List
Request body for PATCH
JSON example
{
  "isActive": "false",
  "status": "Draft",
  "documentGenerationMechanism": "ClientSide",
  "extractOmniDataTransformName": "Extractor",
  "mapperOmniDataTransformName": "Mapper",
  "shouldDisplayUnmappedToken": "false",
  "tokenList": "token1,token2,token3",
  "tokenMappingMethodType": "OmniDataTransform",
  "usageType": "Contract_Lifecycle_Management",
  "contentDocumentId": "069xxxxxxxxxxxxxxx"
}
Properties
Name Type Description Required or Optional Available Version
content​Document​Id String ID of the document associated with a document template. Optional 60.0
document​Generation​Mechanism String Method for generating the document. Optional 60.0
extract​OmniData​Transform​Name String Name of the OmniDataTransform bundle of the extract type. Optional 60.0
isActive Boolean Indicates whether the document template is set to active (true) or inactive (false). Optional 60.0
mapper​OmniData​Transform​Name String Name of the OmniDataTransform bundle of the mapper type. Optional 60.0
should​Display​Unmapped​Token Boolean Indicates whether the document template unmapped tokens be displayed (true) or not (false). Optional 60.0
status String Status to be set for the document template. Optional 60.0
tokenList String List of tokens present in the document template. Optional 60.0
token​Mapping​MethodType String Processing method for data that can originate from the same source object. Optional 60.0
usageType String Usage type of the document template. Optional 60.0
Response body for PATCH
Document Template
Request parameters for PATCH
Parameter Name Type Description Required or Optional Available Version
documentTemplateId String ID of the document template for operations like cloning or creating a new version. Required 60.0
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
action String Action to be performed on the document template. Valid values are:
  • Clone
  • NewVersion
 Optional 60.0
documentTemplateId String ID of the document template for operations like cloning or creating a new version. Optional 60.0
Request body for POST
JSON example
{
  "name": "TemplateName",
  "type": "MicrosoftWord/MicrosoftPowerpoint/Microsoft365Word",
  "tokenMappingMethodType": "OmniDataTransform",
  "tokenMappingType": "JSON",
  "extractOmniDataTransformName": "ExtractName",
  "mapperOmniDataTransformName": "MapperName",
  "contentDocumentId": "069xx0000004CyeAAE",
  "documentGenerationMechanism": "ServerSide",
  "usageType": "Contract_Lifecycle_Management",
  "tokenList": "token1,token2,token3"
}
Properties
Name Type Description Required or Optional Available Version
content​DocumentId String ID of the Document associated with a document template. Optional 60.0
document​Generation​Mechanism String Method for generating the document. Optional 60.0
extractOmniDataTransformName String Name of the OmniDataTransform bundle of the extract type. Optional 60.0
mapper​OmniData​Transform​Name String Name of the OmniDataTransform bundle of the mapper type. Optional 60.0
name String Name of the document template. Required 60.0
tokenList String List of tokens present in the document template. Optional 60.0
token​Mapping​MethodType String Processing method for the data that can originate from same source object. Required 60.0
token​Mapping​Type String Mapping type for tokens of the document template. Required 60.0
type String Type of document template. Required 60.0
usageType String Usage type of the document template. Optional 60.0
Response body for POST
Document Template