--- title: "Update Custom Classifier" method: PUT path: "/api/label-manager/v2/custom-classifiers/{classifierName}" tags: ["Classification"] --- # Update Custom Classifier `PUT /api/label-manager/v2/custom-classifiers/{classifierName}` Use this API to update an existing custom classifier. ## Path parameters - `classifierName` string, required ## Request body - DataUseGovernanceDataDiscoveryCustomClassiferManaCustomDetectorDto - `name` string, required — The name of the classifier. - `description` string — The description of the classifier. - `isPII` boolean, required — This flag indicates whether the classifier contains personally identifiable information. - `definition` DataUseGovernanceDataDiscoveryCustomClassiferManaDetectorDefinition, required - `name` string — The name of the classifier definition. - `otCode` string — The OneTrust code assigned to the classifier definition. - `isCustom` boolean — This flag indicates whether the classifier definition is custom-created. - `VERSION` integer — The version number of the classifier definition. - `SCHEMA_VERSION` string — The schema version used for the classifier definition. - `metadata` DataUseGovernanceDataDiscoveryCustomClassiferManaDetectorMetadata - `displayName` string — The display name used for the classifier in user interfaces. - `otDisplayName` string — The OneTrust display name used for the classifier. - `description` string — The description of the classifier metadata. - `locations` string[] — The list of geographic locations where the classifier applies. - `languages` string[] — The list of languages supported by the classifier. - `industries` string[] — The list of industries where the classifier is applicable. - `categories` string[] — The list of categories assigned to the classifier. - `sensitivityLevel` string — The sensitivity level assigned to the classifier data. - `detections` DataUseGovernanceDataDiscoveryCustomClassiferManaPotentialMatchRule[] — The list of detectors used to establish the best matching criteria. - `type` 'PATTERN' | 'DICTIONARY' | 'SURROGATE', required — The type of detector used for pattern matching. - `pattern` DataUseGovernanceDataDiscoveryCustomClassiferManaRegexPatternConfig - `regex` string, required — The regular expression pattern used in the detection rule. - `flags` string — The flags that control the regex pattern matching logic in the detection rule. - `groupIndexes` integer[] — The list of group indexes to extract from the detection rule regex match. - `dictionary` DataUseGovernanceDataDiscoveryCustomClassiferManaDictionaryConfig - `terms` string[], required — The list of terms or keywords used in the detection rule dictionary. - `ignoreCase` boolean — This flag indicates whether the detection rule dictionary ignores case sensitivity. - `surrogate` DataUseGovernanceDataDiscoveryCustomClassiferManaSurrogateConfig - `name` string — The classifier code for the existing detector being used as the base classifier. - `likelihood` 'NO_MATCH' | 'VERY_UNLIKELY' | 'UNLIKELY' | 'POSSIBLE' | 'LIKELY' | 'VERY_LIKELY' — The initial likelihood level assigned to the detector. - `description` string — The description of the detector used for pattern matching. - `name` string, required — The name of the detector used for pattern matching. - `prerequisite` DataUseGovernanceDataDiscoveryCustomClassiferManaPrerequisite - `minLength` integer — The minimum length requirement for the detected data. - `requirements` string[] — The list of requirements that must be satisfied for the detector. - `wordFilter` string[] — The list of words used to filter detection results. - `wordFilterFlags` DataUseGovernanceDataDiscoveryCustomClassiferManaFilterFlags - `ignoreCase` boolean — This flag indicates whether word filtering ignores case sensitivity. - `inverse` boolean — This flag indicates whether to apply inverse word filtering logic. - `startBoundary` 'ALWAYS' | 'NEVER' | 'IGNORE' — The boundary condition applied at the start of word filtering. - `endBoundary` 'ALWAYS' | 'NEVER' | 'IGNORE' — The boundary condition applied at the end of word filtering. - `detectionRules` DataUseGovernanceDataDiscoveryCustomClassiferManaDetectionRule[] — The list of detection rules used to validate and adjust the likelihood result. - `type` 'PATTERN' | 'DICTIONARY' | 'VALIDATOR', required — The type of detection rule applied to validate matches. - `name` string — The name of the detection rule used for validation. - `dictionary` DataUseGovernanceDataDiscoveryCustomClassiferManaDictionaryConfig - `terms` string[], required — The list of terms or keywords used in the detection rule dictionary. - `ignoreCase` boolean — This flag indicates whether the detection rule dictionary ignores case sensitivity. - `pattern` DataUseGovernanceDataDiscoveryCustomClassiferManaRegexPatternConfig - `regex` string, required — The regular expression pattern used in the detection rule. - `flags` string — The flags that control the regex pattern matching logic in the detection rule. - `groupIndexes` integer[] — The list of group indexes to extract from the detection rule regex match. - `validator` DataUseGovernanceDataDiscoveryCustomClassiferManaValidatorConfig - `type` 'ABA_ROUTING_NUMBER' | 'ACH_ROUTING_NUMBER' | 'ALL_DIGITS_IN_SEQUENCE' | 'ALL_DIGITS_SAME' | 'ARGENTINA_CUIT_CUIL' | 'AUSTRALIA_MEDICAL_ACCOUNT' | 'AUSTRALIAN_ABN' | 'AUSTRALIAN_ACN' | 'AUSTRALIAN_TFN' | 'AUSTRIA_SSN' | 'AUSTRIA_TIN' | 'BELGIUM_NATIONAL_NUMBER' | 'BELGIUM_VAT' | 'BRAZIL_CNH' | 'BRAZIL_CNPJ' | 'BRAZIL_CPF' | 'BRAZIL_RG' | 'CHILEAN_RUT' | 'CDCCM_CODE' | 'CDCPCS_CODE' | 'CELL_CONTENT' | 'CITY' | 'CREDIT_CARD' | 'CROATIA_OIB' | 'CUSIP' | 'CYPRUS_TIN' | 'CZECH_SLOVAK_PERSONAL_ID' | 'DATE' | 'DEA_NUMBER' | 'DENMARK_PERSONAL_ID' | 'EAN13' | 'FINLAND_NATIONAL_ID' | 'FRANCE_INSEE' | 'FRANCE_TIN' | 'FRANCE_VAT' | 'GERMAN_NATIONAL_ID_NUMBER' | 'GERMAN_TIN' | 'GERMAN_VAT' | 'HONG_KONG_HKID' | 'HUNGARY_PERSONAL_ID' | 'HUNGARY_TIN' | 'HUNGARY_TAJ' | 'HUNGARY_VAT' | 'IBAN_CODE' | 'IF_CODE' | 'IMSI' | 'INDIA_GST' | 'INDONESIA_KTP' | 'IRELAND_PPSN' | 'ISBN' | 'ISIN' | 'ISSN' | 'ITALY_FISCAL_CODE' | 'JAPAN_CORPORATE_NUMBER' | 'JAPAN_INDIVIDUAL_NUMBER' | 'KOREA_RRN' | 'LITHUANIA_PERSONAL_CODE' | 'LUHN' | 'LUXEMBOURG_NATIONAL_ID' | 'MEXICO_CURP' | 'NETHERLANDS_BSN' | 'NETHERLANDS_TIN' | 'NETHERLANDS_VAT' | 'NEW_ZEALAND_IRD' | 'NEW_ZEALAND_NHI' | 'NORWAY_IDENTIFICATION_NUMBER' | 'NPI' | 'PHONE_NUMBER' | 'POLISH_ID_CARD' | 'POLISH_PESEL' | 'POLISH_TIN' | 'PORTUGAL_CITIZEN_CARD' | 'PORTUGAL_TIN' | 'REGON_NUMBER' | 'ROMANIA_CNP' | 'SEDOL' | 'SINGAPORE_NRIC' | 'SLOVENIA_JMBG' | 'SOUTH_AFRICAN_ID' | 'SOUTH_AFRICAN_TIN' | 'SPAIN_DNI' | 'SPAIN_NIF' | 'SPAIN_SSN' | 'STRING_REQUIREMENTS' | 'SWEDEN_NATIONAL_ID_NUMBER' | 'SWIFT_CODE' | 'SWISS_AHV' | 'TAIWAN_UI' | 'THAILAND_NATIONAL_ID_CODE' | 'TURKEY_NATIONAL_ID' | 'UAE_ID_CARD' | 'UDI_GS1' | 'UDI_HIBCC' | 'UDI_ICCBBA' | 'UK_NHS' | 'UKNHS_NUMBER' | 'US_VIN' | 'VERHOEFF', required — The type of validator used in the detection rule. - `options` object — The configuration options for the validator used in the detection rule. - `inverse` boolean — This flag indicates whether to return matches that meet or do not meet the detection rule criteria. - `target` 'FINDING' | 'CONTEXT' | 'XPATH' | 'OBJECT_NAME' | 'OBJECT_PARENT' | 'FILE_EXTENSION' | 'FILE_NAME' | 'COLUMN_NAME' — The target option where the detection rule is applied. - `context` DataUseGovernanceDataDiscoveryCustomClassiferManaContextConfig - `windowBefore` integer — The maximum number of characters to include for context before the match. - `windowAfter` integer — The maximum number of characters to include for context after the match. - `likelihoodAdjustment` DataUseGovernanceDataDiscoveryCustomClassiferManaLikelihoodAdjustment - `adjustLikelihood` integer — The integer value used to adjust the likelihood level based on the current likelihood when detection rule criteria are met. - `setLikelihood` 'NO_MATCH' | 'VERY_UNLIKELY' | 'UNLIKELY' | 'POSSIBLE' | 'LIKELY' | 'VERY_LIKELY' — The target likelihood level that is set when detection rule criteria are met regardless of the current level. - `type` string — The strategy used to adjust the likelihood level when detection rule criteria are met. - `includeExpand` boolean — This flag indicates whether to include context that matches or does not match the detection rule criteria. - `evaluations` DataUseGovernanceDataDiscoveryCustomClassiferManaEvaluation[] — The list of evaluation test cases used to validate the classifier. - `text` string — The sample text used for evaluation testing. - `match` string[] — The list of expected matches for the evaluation test case. - `metadata` DataUseGovernanceDataDiscoveryCustomClassiferManaMetadata - `XPATH` string — The XPath expression used in the evaluation metadata. - `OBJECT_NAME` string — The object name used in the evaluation metadata. - `OBJECT_PARENT` string — The parent object name used in the evaluation metadata. - `xpath` string — The XPath expression used in the evaluation metadata. - `glossaryTerm` DataUseGovernanceDataDiscoveryCustomClassiferManaGlossaryTermDto - `name` string — The name of the glossary term associated with the classifier. - `id` string, uuid — The unique identifier of the glossary term associated with the classifier. - `detectorVersion` integer — The version number of the detector used by the classifier. - `id` string, uuid — The unique identifier of the classifier. - `code` string — The system-generated code of the classifier. - `custom` boolean — This flag indicates whether the classifier is custom-created. - `enabled` boolean — This flag indicates whether the classifier is active. - `surrogateType` string — The surrogate type associated with the classifier. - `detectorType` 'PATTERN' | 'DICTIONARY' | 'SURROGATE' | 'VALIDATOR' | 'TEMPLATE' | 'COMPLEX' — The type of detector used by the classifier to classify data. - `isGlossaryTermChanged` boolean — This flag indicates whether the glossary term association has changed. - `lastModifiedDate` string, date-time — The date and time when the classifier was last modified. - `createdDate` string, date-time — The date and time when the classifier was created. - `createdBy` string, uuid — The unique identifier of the user that created the classifier. - `lastModifiedBy` string, uuid — The unique identifier of the user that last modified the classifier. - `version` integer — The version number used for optimistic locking. ## Response `200` Custom classifier updated successfully ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500` — Internal Server Error --- [API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)