Update Layout
PATCH {{baseUrl}}/api/v1/layouts/:layout_id
This API updates details of an existing layout.
OAuth Scope
Desk.settings.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| isDefaultLayout | <boolean> | Key that returns if the layout is the default layout in the module |
| sections | <list> | sections in the layout |
| module | <string> max chars : 100 | mdoule name |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"modifiedTime":"2017-07-01T07:36:04.000Z","skipDeptAccessValidation":false,"createdBy":"4000000009118","departmentId":"4000000007175","layoutDisplayName":"ClonedLayout","createdTime":"2017-07-01T07:36:04.000Z","modifiedBy":"","id":"4000000007177","isDefaultLayout":true,"sections":[{"name":"Ticket Information","isCustomSection":false,"id":1,"fields":[{"displayLabel":"Department","apiName":"departmentId","isCustomField":false,"isEncryptedField":false,"id":"4000000000353","isSystemMandatory":false,"isRemovable":false,"type":"LookUp","maxLength":50,"isMandatory":true},{"displayLabel":"Contact Name","apiName":"contactId","isCustomField":false,"isEncryptedField":false,"id":"4000000000357","isSystemMandatory":true,"isRemovable":false,"type":"LookUp","maxLength":300,"isMandatory":true},{"displayLabel":"Account Name","apiName":"accountId","isCustomField":false,"isEncryptedField":false,"id":"4000000000355","isSystemMandatory":false,"isRemovable":true,"type":"LookUp","maxLength":300,"isMandatory":false},{"displayLabel":"Email","apiName":"email","isCustomField":false,"isEncryptedField":false,"id":"4000000000359","isSystemMandatory":false,"isRemovable":false,"type":"Email","maxLength":120,"isMandatory":false},{"displayLabel":"Phone","apiName":"phone","isCustomField":false,"isEncryptedField":false,"id":"4000000000361","isSystemMandatory":false,"isRemovable":true,"type":"Phone","maxLength":120,"isMandatory":false},{"displayLabel":"Sub Category","allowedValues":["Sub General","Sub Defects"],"apiName":"subCategory","isCustomField":false,"defaultValue":"Sub General","isSystemMandatory":false,"type":"Picklist","isEncryptedField":false,"sortBy":"userDefined","id":"4000000000423","isRemovable":true,"maxLength":120,"isMandatory":false},{"displayLabel":"Category","allowedValues":["General","Defects"],"apiName":"category","isCustomField":false,"defaultValue":"General","isSystemMandatory":false,"type":"Picklist","isEncryptedField":false,"sortBy":"userDefined","id":"4000000000421","isRemovable":true,"maxLength":120,"isMandatory":false},{"displayLabel":"Subject","apiName":"subject","isCustomField":false,"isEncryptedField":false,"id":"4000000000363","isSystemMandatory":true,"isRemovable":false,"type":"Text","maxLength":255,"isMandatory":true},{"displayLabel":"Description","apiName":"description","isCustomField":false,"isEncryptedField":false,"id":"4000000000365","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Status","allowedValues":["Open","Open_july","On Hold","Escalated","Closed1","Closed","newDeptClosed"],"apiName":"status","isCustomField":false,"defaultValue":"Open","isSystemMandatory":true,"type":"Picklist","restoreOnReplyValues":["Open_july","newDeptClosed","Escalated","On Hold","Closed","Closed1","Open"],"isEncryptedField":false,"sortBy":"userDefined","id":"4000000000367","isRemovable":false,"maxLength":120,"isMandatory":true},{"displayLabel":"Case Owner","apiName":"assigneeId","isCustomField":false,"isEncryptedField":false,"id":"4000000000371","isSystemMandatory":false,"isRemovable":false,"type":"LookUp","maxLength":120,"isMandatory":false},{"displayLabel":"Product Name","apiName":"productId","isCustomField":false,"isEncryptedField":false,"id":"4000000000369","isSystemMandatory":false,"isRemovable":true,"type":"LookUp","maxLength":120,"isMandatory":false}]},{"name":"Additional Information","isCustomSection":false,"id":2,"fields":[{"displayLabel":"Due Date","apiName":"dueDate","isCustomField":false,"isEncryptedField":false,"id":"4000000000405","isSystemMandatory":false,"isRemovable":false,"type":"DateTime","maxLength":300,"isMandatory":false},{"displayLabel":"Priority","allowedValues":["-None-","High","Medium","Low"],"apiName":"priority","isCustomField":false,"defaultValue":"-None-","isSystemMandatory":false,"type":"Picklist","isEncryptedField":false,"sortBy":"userDefined","id":"4000000000407","isRemovable":false,"maxLength":120,"isMandatory":false},{"displayLabel":"Mode","allowedValues":["Phone","Email","Web","Twitter","Facebook","Chat","Forums","Feedback Widget"],"apiName":"channel","isCustomField":false,"defaultValue":"Phone","isSystemMandatory":false,"type":"Picklist","isEncryptedField":false,"sortBy":"userDefined","id":"4000000000409","isRemovable":false,"maxLength":120,"isMandatory":false},{"displayLabel":"Is Overdue","apiName":"Is Overdue","isCustomField":false,"defaultValue":"true","isEncryptedField":false,"id":"4000000000411","isSystemMandatory":false,"isRemovable":true,"type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Is Escalated","apiName":"Is Escalated","isCustomField":false,"defaultValue":"true","isEncryptedField":false,"id":"4000000000413","isSystemMandatory":false,"isRemovable":true,"type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Classification","allowedValues":["-None-","Question","Problem","Feature","Others"],"apiName":"classification","isCustomField":false,"defaultValue":"-None-","isSystemMandatory":false,"type":"Picklist","isEncryptedField":false,"sortBy":"userDefined","id":"4000000000415","isRemovable":true,"maxLength":120,"isMandatory":false},{"displayLabel":"Resolution","apiName":"resolution","isCustomField":false,"isEncryptedField":false,"id":"4000000000417","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Sample TextArea","apiName":"cf_sample_textarea","isCustomField":true,"toolTipType":"placeHolder","isEncryptedField":false,"toolTip":"Sample Field","id":"4000000000447","isSystemMandatory":false,"isRemovable":false,"type":"Textarea","maxLength":1000000,"isMandatory":false}]}],"layoutDesc":"Layout cloned from default layout","layoutName":"Default Ticket Layout"}