Delete custom field value
Use case
In this scenario, we have a value for one of the custom fields in a particular loan contract. Here we will see how to delete the custom field value.
Use case data
API parameter with values
The entity name (in this case, LOAN.CONTRACT_HEADER).
The loan contract number.
The field ID whose value you want to delete.
Sample API call
To delete the custom field value, use the following endpoint:
Sample request
The sample request body is as follows:
{
"source": {
"sourceName": "LOAN.CONTRACT_HEADER",
"sourceRef": "INST2-1000"
},
"fieldId": "AssetVal"
}
curl -X 'DELETE' \
'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.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTU6MDA6MTAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNjIwMTB9.gScjkG6yEBnptOA9H4jGw5Jss8t5g5sOM7KU_AFpbCg' \
-H 'Content-Type: application/json' \
-d '{
"source": {
"sourceName": "LOAN.CONTRACT_HEADER",
"sourceRef": "INST2-1000"
},
"fieldId": "AssetVal"
}'
Sample response
Below you will find the response to the sample request:
Response
{
"errors": null,
"validationErrors": null,
"data": null
}
Result
The value of the custom field AssetVal of the LOAN.CONTRACT_HEADER entity has been deleted.
