Add Lookup type blocked values
Learn how to add a blocked value for a specific lookup type.
The Add lookup type blocked value API adds a value to the blocked values list for a specific lookup type. It excludes blocked values from Autopilot processing for that lookup type, so the system does not consider them during matching or suggestion evaluation. The response confirms whether the system successfully added the value.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
POST /configuration/{tenantId}/autopilot/{lookupType}/blockedValuesThis endpoint adds a new blocked value for the specified lookup type within the given tenant.
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 the value to block.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
value | String | No | Single value to block. | The input must not contain "/". Additionally, at least one of the value or values parameters must be provided. |
values | Array of strings | No | List of values to block. | Maximum 1000 values per request (combined with value). Values must not contain /. |
Example request
Use the following example to see how the request body is structured.
Example: Single value
{
"value": "INVALID_VALUE"
}Example: Batch of values
{
"values": ["TEST", "NA", "UNKNOWN"]
}Response body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
status | String | Indicates the result of the operation |
Example response
The following example shows a successful response.
{
"status": "success"
}