Create lookup code for existing type

Use case

Here we will create a lookup code DECLINED for an existing lookup type code STATUS for the LOAN.LOAN_APPLICATION entity.

Use case data
API parameters with values

The first path parameter is the entity name (in this case, LOAN.LOAN_APPLICATION).

"...entity/LOAN.LOAN_APPLICATION..."

The second path parameter is the existing lookup type code (in this case, STATUS). Note: The lookup type must exist. If you want to create new lookup types, see the Create a lookup type and codes topic.

"...lookup-type/STATUS"

The lookup code we want to create.

"lookupCode": "DECLINED"

Sample API call

To create the lookup code, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity/LOAN.LOAN_APPLICATION/lookup-type/STATUS/lookup

Learn more about the create lookup code endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

{
  "lookupCode": "DECLINED",
  "translations": [
    {
      "languageCode": "en",
      "translation": "Loan application declined"
    }
  ]
}

Sample response

Below you will find the response to the sample request:

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

Result

We have created a new lookup code for the STATUS lookup type for loan applications.

Last updated

Was this helpful?