Add tenant level blocked values

Learn how to add a blocked value that applies across all lookup types for a tenant.

The Add tenant level blocked value API adds a value to the tenant-level blocked values list. Blocked values apply across all lookup types and are excluded from Autopilot processing.

The response confirms whether the operation was successful.

Note: Use Blocked Values to prevent Autopilot from acting on specific values. You can configure them at the tenant level or per lookup type, and both apply before evaluation.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

POST /configuration/{tenantId}/autopilot/blockedValues

This endpoint adds a new blocked value for the specified tenant.

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Tenant identifier

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	Yes	Value to block	—

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": ["NA", "UNKNOWN", "TBD"]
}

Example: Combined values

{
  "value": "INVALID_VALUE",
  "values": ["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"
}

Validation Rules

The request must meet the following validation rules:

Provide at least one of value or values in the request body
Submit no more than 1,000 total values per request (including both value and values)
Do not include the / character in any value

Unify and manage your data