Create or update Lookup type Configuration
Learn how to create or update configuration settings for a specific lookup type in the Autopilot configuration.
Use Create or update Lookup type configuration API to save the Autoplilot configuration for a specific lookup type. If Autopilot settings are not configured for a specific lookup type, the system creates a new configuration using the provided settings. If a configuration already exists for the lookup type, the API updates the existing settings instead.
This operation returns the full updated Autopilot configuration for the tenant.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
PUT /configuration/{tenantId}/autopilot/{lookupType}
This endpoint creates or updates the Autopilot configuration for the specified lookup type within the given tenant context.
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Tenant identifier |
lookupType | String | Yes | Lookup type name |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {token} | Yes |
Request body
The request body must contain an Autopilot configuration object.
| Field | Type | Description |
|---|---|---|
enabled | boolean | Enables or disables Autopilot. |
mode | string | Operating mode for Autopilot. |
autoMapEnabled | boolean | Enables automatic mapping. |
autoMapThreshold | number | Confidence threshold for automatic mapping. |
suggestionEnabled | boolean | Enables suggestions for mapping. |
suggestionThreshold | number | Confidence threshold for suggestions. |
misspelledThreshold | number | Threshold used for misspelling detection. |
requiredFrequency | integer | Minimum occurrence frequency required before applying certain actions. |
frequencyWindowHours | integer | Time window, in hours, used when evaluating frequency. |
Example request
Use the following example to see how the request body is structured.
{
"enabled": true,
"mode": "ACTIVE",
"autoMapEnabled": true,
"autoMapThreshold": 0.70,
"suggestionEnabled": true,
"suggestionThreshold": 0.50,
"misspelledThreshold": 0.85,
"requiredFrequency": 5,
"frequencyWindowHours": 24
}
Response Body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
tenantId | String | Unique identifier of the tenant associated with the configuration. |
| defaults | ||
defaults | Object | Default configuration settings applied when no lookup-specific override is defined. |
enabled | Boolean | Indicates whether the default configuration is enabled. |
mode | String | Operational mode of the default configuration. |
autoMapEnabled | Boolean | Determines whether automatic mapping is enabled by default. |
autoMapThreshold | Number | Threshold value used to determine automatic mapping eligibility. |
suggestionEnabled | Boolean | Indicates whether suggestion generation is enabled by default. |
suggestionThreshold | Number | Threshold value used for generating suggestions. |
createLookupEnabled | Boolean | Indicates whether automatic lookup creation is enabled. |
createLookupThreshold | Number | Threshold value for creating new lookup entries. |
suggestLookupEnabled | Boolean | Indicates whether lookup suggestions are enabled. |
suggestLookupThreshold | Number | Threshold value for lookup suggestions. |
misspelledThreshold | Number | Threshold value used to detect misspelled entries. |
requiredFrequency | Number | Minimum frequency required for processing or triggering logic. |
frequencyWindowHours | Number | Time window, in hours, used to evaluate frequency. |
| lookupTypes | ||
lookupTypes | Array | List of lookup type-specific configurations that override default settings. |
uri | String | URI that identifies the lookup type. |
| settings | ||
settings | Object | Configuration settings specific to the lookup type. |
enabled | Boolean | Indicates whether the lookup type configuration is enabled. |
mode | String | Operational mode for the lookup type. |
autoMapEnabled | Boolean | Determines whether automatic mapping is enabled for the lookup type. |
autoMapThreshold | Number | Threshold value for automatic mapping for the lookup type. |
suggestionEnabled | Boolean | Indicates whether suggestions are enabled for the lookup type. |
suggestionThreshold | Number | Threshold value for suggestions for the lookup type. |
createLookupEnabled | Boolean | Indicates whether lookup creation is enabled for the lookup type. |
createLookupThreshold | Number | Threshold value for lookup creation for the lookup type. |
suggestLookupEnabled | Boolean | Indicates whether lookup suggestions are enabled for the lookup type. |
suggestLookupThreshold | Number | Threshold value for lookup suggestions for the lookup type. |
misspelledThreshold | Number | Threshold value used to detect misspellings for the lookup type. |
requiredFrequency | Number | Minimum frequency required for the lookup type. |
frequencyWindowHours | Number | Time window, in hours, used for frequency evaluation for the lookup type. |
updatedBy | String | Identifier of the user who last updated the configuration. |
updateDate | Number | Timestamp of the last update in epoch milliseconds. |
version | Number | Version number of the configuration. |
anyEnabled | Boolean | Indicates whether any configuration (default or lookup-specific) is enabled. |
Example response
The following example shows a response with tenant-level default settings, lookup type-specific override settings, and audit metadata for lookup matching configuration.
{
"tenantId": "my_tenant",
"defaults": {
"enabled": true,
"mode": "ACTIVE",
"autoMapEnabled": true,
"autoMapThreshold": 0.9,
"suggestionEnabled": true,
"suggestionThreshold": 0.8,
"createLookupEnabled": true,
"createLookupThreshold": 0.9,
"suggestLookupEnabled": true,
"suggestLookupThreshold": 0.8,
"misspelledThreshold": 0.7,
"requiredFrequency": 1,
"frequencyWindowHours": 1
},
"lookupTypes": [
{
"uri": "rdm/lookupTypes/Country",
"settings": {
"enabled": true,
"mode": "ACTIVE",
"autoMapEnabled": false,
"autoMapThreshold": 0.7,
"suggestionEnabled": false,
"suggestionThreshold": 0.5,
"createLookupEnabled": false,
"createLookupThreshold": 0.9,
"suggestLookupEnabled": false,
"suggestLookupThreshold": 0.75,
"misspelledThreshold": 0.7,
"requiredFrequency": 5,
"frequencyWindowHours": 1
}
},
{
"uri": "rdm/lookupTypes/City",
"settings": {
"enabled": true,
"mode": "ACTIVE",
"autoMapEnabled": true,
"autoMapThreshold": 0.95,
"suggestionEnabled": true,
"suggestionThreshold": 0.8,
"createLookupEnabled": false,
"createLookupThreshold": 0.9,
"suggestLookupEnabled": false,
"suggestLookupThreshold": 0.8,
"misspelledThreshold": 0.85,
"requiredFrequency": 5,
"frequencyWindowHours": 24
}
}
],
"updatedBy": "my_user",
"updateDate": 1777458890014,
"version": 9,
"anyEnabled": true
}