Update custom field value

Use case

We want to update the value of a custom field in a particular loan contract.

Use case data	API parameter with values
The field ID and the value you want to update for the field.	"fieldId": "AssetVal", "fieldValue": "4500"
The entity name and the contract number for which you want to update the custom value.	"sourceName": "LOAN.CONTRACT_HEADER", "sourceRef": "INST2-1000"

Sample API call

To update the custom field value, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/value

Learn more about the update custom field value endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

JSON

{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}

cURL

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/value' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTM6MjE6NDIiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNTYxMDJ9.Z1frJzD4gdb6P9sQ_D74s7tjj4Httc5cXEKuihXEHP4' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": {
    "sourceName": "LOAN.CONTRACT_HEADER",
    "sourceRef": "INST2-1000"
  },
  "fieldId": "AssetVal",
  "fieldValue": "4500"
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": null
}

Result

We have now updated the value of the custom field fieldValue for the loan contract:

• From the previous value 5000,

• To the new value 4500.