Deactivate field

Use case

If you do not want to use a custom field for an entity, you can deactivate it. Here we will learn how to do this.

You cannot delete a custom field once you have created it, you can only deactivate it.

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 ID of the custom field that you want to deactivate.	"...field/AssetVal..."

Sample API call

To deactivate the custom field, use the following endpoint:

https://loan-api.sandbox.tuumplatform.com/api/v1/custom-fields/LOAN.CONTRACT_HEADER/field/AssetVal/deactivate

Learn more about the deactivate field endpoint in the Tuum developer portal.

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": {
    "fieldId": "AssetVal",
    "name": "AssetAmount",
    "fieldSetId": "Contract Extras",
    "entityName": "LOAN.CONTRACT_HEADER",
    "valueType": "NUMBER",
    "unique": false,
    "required": false,
    "active": false,
    "copyFromEntityName": null,
    "copyFromFieldId": null,
    "activityCode": null,
    "lookupEntityName": null,
    "lookupTypeCode": null
  }
}

Result

The custom field AssetVal has been deactivated and will not be usable for the loan contract header entity.

To activate the field, use the Update field endpoint and set the parameter as "active": true.