Qodex.ai

Update Layout Rule

PATCH {{baseUrl}}/api/v1/layouts/:layout_id/layoutRules/{layoutRule_id}

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

OAuth Scope

  • Desk.settings.UPDATE

Request Params

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

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"fieldConditions":[{"name":"condition 1","pattern":"(1and2)or3","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"accountId","value":["Ramkumar"]},{"condition":"is","fieldName":"productId","value":["Honda"]}],"actions":{"showSections":["Additional Information"],"showFields":["subject"],"setMandatoryFields":["priority"]}},{"name":"condition 2","pattern":"1 and (2 or 3)","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"accountId","value":["Sundar"]},{"condition":"is","fieldName":"productId","value":["Maruthi"]}],"actions":{"showSections":[],"showFields":["subject"],"setMandatoryFields":["Description"]}}],"modifiedTime":"2018-09-14T01:08:42.000Z","fieldName":"email","description":"Rule 1 for layout","systemGenerated":false,"layoutId":"4000000007723","executeInHelpCentre":false,"createdBy":"4000000015963","name":"Rule 11","createdTime":"2018-09-14T01:07:22.000Z","modifiedBy":"4000000015963","id":"4000000021001","status":"active"}