Update field set

Use case

We want to update the name of an existing field set in the loan contract header entity.

You can only update the name of a field set. The ID cannot be updated.

Use case data	API parameter with values
The first path parameter is the entity name (in this case, LOAN.CONTRACT_HEADER).	".../custom-fields/LOAN.CONTRACT_HEADER..."
The second path parameter is the field set ID whose name you want to update.	".../field-set/Contract%20Extras"
In the body, we will enter the new field name.	"name": "Extra details for contract headers"

Sample API call

To update the field set name, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set/Contract%20Extras

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

Sample request

The sample request body is as follows:

JSON

{
  "name": "Extra details for contract headers"
}

cURL

curl -X 'PUT' \
  'https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field-set/Contract%20Extras' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMjZUMTE6Mzg6MTQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTMwNDk4OTR9.h1D0THssTHbFygVvRpwI6Bcz9TrogtS80wvf8IqTrI4' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Extra details for contract headers"
}'

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "entityName": "LOAN.CONTRACT_HEADER",
    "fieldSetId": "Contract Extras",
    "name": "Extra details for contract headers"
  }
}

Result

We have now updated the field set name:

• From the previous name "Contracts",

• To the new name "Extra details for contract headers".