Unify and manage your data

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.

ParameterTypeRequiredDescription
tenantIdStringYesTenant identifier
lookupTypeStringYesLookup type name

Request headers

The following request headers must be included.

HeaderValueRequired
AuthorizationBearer {token}Yes

Request body

The request body must contain an Autopilot configuration object.

FieldTypeDescription
enabledbooleanEnables or disables Autopilot.
modestringOperating mode for Autopilot.
autoMapEnabledbooleanEnables automatic mapping.
autoMapThresholdnumberConfidence threshold for automatic mapping.
suggestionEnabledbooleanEnables suggestions for mapping.
suggestionThresholdnumberConfidence threshold for suggestions.
misspelledThresholdnumberThreshold used for misspelling detection.
requiredFrequencyintegerMinimum occurrence frequency required before applying certain actions.
frequencyWindowHoursintegerTime 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.

FieldTypeDescription
tenantIdStringUnique identifier of the tenant associated with the configuration.
defaults
defaultsObjectDefault configuration settings applied when no lookup-specific override is defined.
enabledBooleanIndicates whether the default configuration is enabled.
modeStringOperational mode of the default configuration.
autoMapEnabledBooleanDetermines whether automatic mapping is enabled by default.
autoMapThresholdNumberThreshold value used to determine automatic mapping eligibility.
suggestionEnabledBooleanIndicates whether suggestion generation is enabled by default.
suggestionThresholdNumberThreshold value used for generating suggestions.
createLookupEnabledBooleanIndicates whether automatic lookup creation is enabled.
createLookupThresholdNumberThreshold value for creating new lookup entries.
suggestLookupEnabledBooleanIndicates whether lookup suggestions are enabled.
suggestLookupThresholdNumberThreshold value for lookup suggestions.
misspelledThresholdNumberThreshold value used to detect misspelled entries.
requiredFrequencyNumberMinimum frequency required for processing or triggering logic.
frequencyWindowHoursNumberTime window, in hours, used to evaluate frequency.
lookupTypes
lookupTypesArrayList of lookup type-specific configurations that override default settings.
uriStringURI that identifies the lookup type.
settings
settingsObjectConfiguration settings specific to the lookup type.
enabledBooleanIndicates whether the lookup type configuration is enabled.
modeStringOperational mode for the lookup type.
autoMapEnabledBooleanDetermines whether automatic mapping is enabled for the lookup type.
autoMapThresholdNumberThreshold value for automatic mapping for the lookup type.
suggestionEnabledBooleanIndicates whether suggestions are enabled for the lookup type.
suggestionThresholdNumberThreshold value for suggestions for the lookup type.
createLookupEnabledBooleanIndicates whether lookup creation is enabled for the lookup type.
createLookupThresholdNumberThreshold value for lookup creation for the lookup type.
suggestLookupEnabledBooleanIndicates whether lookup suggestions are enabled for the lookup type.
suggestLookupThresholdNumberThreshold value for lookup suggestions for the lookup type.
misspelledThresholdNumberThreshold value used to detect misspellings for the lookup type.
requiredFrequencyNumberMinimum frequency required for the lookup type.
frequencyWindowHoursNumberTime window, in hours, used for frequency evaluation for the lookup type.
updatedByStringIdentifier of the user who last updated the configuration.
updateDateNumberTimestamp of the last update in epoch milliseconds.
versionNumberVersion number of the configuration.
anyEnabledBooleanIndicates 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
}