Agentforce Health Developer Guide
jRecord Update with Received Documents (PATCH)
Update an existing record in a Salesforce object using a document
based on a received document record.
Resource
1/connect/form-reader/receivedDocuments/${receivedDocumentId}/record/${targetRecordId}Resource Example
1https://yourInstance.salesforce.com/services/data/vXX.X/connect/form-reader/receivedDocuments/0ioxx0000000001AAA/record/001xx000003GavnAACAvailable Version
55.0
Requires Chatter
No
HTTP Methods
PATCH
Request Body for PATCH
Root XML tag
<DocumentProcessInput>
JSON Example
1{
2 "documentTypeId": "0dexx0000000001",
3 "overrideConfidenceScoreThreshold": 100,
4 "ignoreFieldValueConflict": false,
5 "attachDocument": true,
6 "fieldsWithoutConflictList": {
7 "noConflictFields": [
8 {
9 "field": "name"
10 },
11 {
12 "field": "accountnumber"
13 }
14 ]
15 }
16 "templateApiName": "sample_template"
17}Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalFields | Map<String, Object> | List of additional fields that you want to create or update in the target object and which are not present in the Intelligent Form Reader field mappings. | Optional | 55.0 |
| attachDocument | Boolean | Indicates whether to automatically create the DocumentChecklistItem (DCI)
and ContentDocumentLink records to link the document to the target object
(true) or not (false). Default value is false. |
Optional | 55.0 |
| documentTypeId | String | ID of the document type for the document checklist item. | Optional | 55.0 |
| fieldsWithoutConflictList | Fields Without Conflict Input[] | List of fields that must not have any conflicts for the record creation or update process. | Optional | 55.0 |
| ignoreFieldValueConflict | Boolean | Indicates whether to ignore conflicts in OCR (true) or not (false). Default value is false. |
Optional | 55.0 |
| linkedObjectId | String | ID of the linked object record. | Optional | 55.0 |
| objectApiName | String | API name of the target object in which you want to create or update a record. | Optional | 55.0 |
| overrideConfidenceScoreThreshold | Integer | Conflict confidence score threshold value for the extracted
value. Note: The value of this field overrides the confidence score threshold value set on the user interface. |
Optional | 55.0 |
| recordTypeId | String | ID of the record type of the target object. | Optional | 55.0 |
| templateApiName | String | API name of the document template to retrieve. | Optional | 59.0 |