Rule Instance - Update

POST

Update Rule Instance

Created rule instances can be idempotently updated with the POST /rule-instances/{ruleInstanceId}.

Path parameters

ruleInstanceIdstringRequired

Request

This endpoint expects an object.
ruleIdstringOptional
filtersmap from strings to anyOptional
Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.
parametersmap from strings to anyOptional
ruleNameAliasstringOptional
riskLevelParametersobjectOptional
actionenumOptional
Allowed values: ALLOWFLAGBLOCKSUSPEND
Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst
riskLevelActionsobjectOptional
triggersOnHitobjectOptional
riskLevelsTriggersOnHitobjectOptional
status"ACTIVE" or "INACTIVE"Optional
Allowed values: ACTIVEINACTIVE
casePriorityenumOptional
Allowed values: P1P2P3P4

Response

This endpoint returns an object.
idstring
typeenum
Allowed values: TRANSACTIONUSERUSER_ONGOING_SCREENING
ruleIdstring
checksForlist of strings
runCountdoubleOptional
hitCountintegerOptional
createdAtdoubleOptional
updatedAtdoubleOptional
filtersmap from strings to anyOptional
Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.
parametersmap from strings to anyOptional
ruleNameAliasstringOptional
riskLevelParametersobjectOptional
actionenumOptional
Allowed values: ALLOWFLAGBLOCKSUSPEND
Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst
riskLevelActionsobjectOptional
triggersOnHitobjectOptional
riskLevelsTriggersOnHitobjectOptional
status"ACTIVE" or "INACTIVE"Optional
Allowed values: ACTIVEINACTIVE
casePriorityenumOptional
Allowed values: P1P2P3P4

Errors

Built with