Create Layout Validation Rule
POST {{baseUrl}}/api/v1/layouts/layout_id/validationRules?fieldName=<string> max chars : 100&fieldConditions=<list>
This API creates a validation rule for a field in a layout.
OAuth Scope
Desk.settings.CREATE
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | string | Additional information related to rules. Values allowed are: creator, modifier | |
fieldName | string | Name of the primary field to be used for creating the validation rule | |
displayLabel | string | Display Label of the primary field to be used for creating the rule | |
status | string | Activation status of the validation rule: ACTIVE or DEACTIVE | |
executeInHelpCentre | string | To execute the rule in help centre or not: true or false | |
fieldConditions | string | Conditions in the validation rule |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
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"}}],"modifiedTime":"2018-09-07T06:50:48.697Z","fieldName":"email","executeInHelpCentre":true,"createdBy":"4000000015963","createdTime":"2018-09-07T06:50:48.697Z","modifiedBy":"4000000015963","id":"4000000018001","systemGenerated":false,"layoutId":"4000000013564","status":"active"}