delete https://{host}/api_gateway/cortex/v1/criteria/
This API enables you to deactivate a search criteria.
Notes
- Make sure that you have appropriate access control configured. For more information, see access group documentation.
- Once a criteria is deactivated, you cannot reactivate it.
Example request
curl --location --request DELETE 'https://eu.api.capillarytech.com/api_gateway/cortex/v1/criteria/68d2a1e165d73016efd26247' \
--header 'Authorization: ' \
--header 'Cookie: _cfuvid=3tvybNaHgrOacVV.JPhKKiIBxI4_dUaT9PgnJghp06Q-1758708531439-0.0.1.1-604800000' \
--data ''Response parameters
| Parameter | Type | Description |
|---|---|---|
| id | STRING | The unique identifier of the search criteria |
| orgId | INTEGER | The organization ID associated with the search criteria |
| name | STRING | The name of the search criteria |
| entityType | STRING | The type of entity (TRANSACTION in this case) |
| fieldDefinitions | ARRAY | An array of field definitions for the search criteria |
| searchDataPolicy | OBJECT | The data retention policy and expiration details |
| active | BOOLEAN | Indicates whether the criteria is active or not |
| bulkJobStatus | STRING | The status of any bulk job associated with the search criteria |
| auditInfo | OBJECT | Information about the creation and last update of the search criteria |