Qodex.ai

Update Layout Validation Rule

PATCH {{baseUrl}}/api/v1/layouts/:layout_id/validationRules/{validationRule_id}

This API updates the details of an existing validation rule in a particular layout.

OAuth Scope

  • Desk.settings.UPDATE

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to rules. Values allowed are: creator, modifier
fieldNamestringName of the primary field to be used for creating the validation rule
displayLabelstringDisplay Label of the primary field to be used for creating the rule
statusstringActivation status of the validation rule: ACTIVE or DEACTIVE
executeInHelpCentrestringTo execute the rule in help centre or not: true or false
fieldConditionsstringConditions in the validation rule

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"fieldConditions":[{"name":"condition 2","pattern":"(1and2)","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"phone","value":["9994219718"]}],"actions":{"alert":"Sample Alert"}},{"name":"condition 3","pattern":"(1and2)","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"phone","value":["99922299922"]}],"actions":{"alert":"Sample Alert1"}}],"modifiedTime":"2018-09-07T06:50:48.697Z","fieldName":"email","description":"Rule 1 for layout","systemGenerated":false,"layoutId":"4000000007723","executeInHelpCentre":false,"createdBy":"4000000015963","name":"Rule 11","createdTime":"2018-09-07T06:50:48.697Z","modifiedBy":"4000000015963","id":"4000000021001","status":"active"}