Create Layout

POST {{baseUrl}}/api/v1/layouts

This API creates the layout

OAuth Scope

  • Desk.settings.CREATE

Attributes

Attribute NameData TypeDescription
isDefaultLayout (required)<boolean>
Key that returns if the layout is the default layout in the module
sections (required)<list>
sections in the layout
module (required)<string>
max chars : 100
mdoule name

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;modifiedTime&quot;:&quot;2019-05-09T04:52:57.000Z&quot;,&quot;departmentId&quot;:&quot;4000000012710&quot;,&quot;module&quot;:&quot;Accounts&quot;,&quot;layoutDisplayName&quot;:&quot;Clonned Account Layout&quot;,&quot;layoutDesc&quot;:&quot;DESC&quot;,&quot;isDefaultLayout&quot;:false,&quot;sections&quot;:[{&quot;name&quot;:&quot;Account Information&quot;,&quot;isCustomSection&quot;:true,&quot;id&quot;:1,&quot;fields&quot;:[{&quot;displayLabel&quot;:&quot;Account Name&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;accountName&quot;,&quot;id&quot;:&quot;4000000000404&quot;,&quot;isSystemMandatory&quot;:true,&quot;isRemovable&quot;:false,&quot;type&quot;:&quot;Text&quot;,&quot;maxLength&quot;:200,&quot;isMandatory&quot;:true},{&quot;displayLabel&quot;:&quot;Email&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;email&quot;,&quot;id&quot;:&quot;4000000000408&quot;,&quot;isSystemMandatory&quot;:false,&quot;isRemovable&quot;:true,&quot;type&quot;:&quot;Email&quot;,&quot;maxLength&quot;:120,&quot;isMandatory&quot;:false},{&quot;displayLabel&quot;:&quot;Phone&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;phone&quot;,&quot;id&quot;:&quot;4000000000406&quot;,&quot;isSystemMandatory&quot;:false,&quot;isRemovable&quot;:true,&quot;type&quot;:&quot;Phone&quot;,&quot;maxLength&quot;:30,&quot;isMandatory&quot;:false},{&quot;displayLabel&quot;:&quot;Website&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;website&quot;,&quot;id&quot;:&quot;4000000000410&quot;,&quot;isSystemMandatory&quot;:false,&quot;isRemovable&quot;:true,&quot;type&quot;:&quot;URL&quot;,&quot;maxLength&quot;:2083,&quot;isMandatory&quot;:false},{&quot;displayLabel&quot;:&quot;Country&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;country&quot;,&quot;id&quot;:&quot;4000000000438&quot;,&quot;isSystemMandatory&quot;:false,&quot;isRemovable&quot;:true,&quot;type&quot;:&quot;Text&quot;,&quot;maxLength&quot;:30,&quot;isMandatory&quot;:false},{&quot;displayLabel&quot;:&quot;Account Owner&quot;,&quot;isCustomField&quot;:false,&quot;name&quot;:&quot;ownerId&quot;,&quot;id&quot;:&quot;4000000000412&quot;,&quot;isSystemMandatory&quot;:false,&quot;isRemovable&quot;:false,&quot;type&quot;:&quot;LookUp&quot;,&quot;maxLength&quot;:120,&quot;isMandatory&quot;:false}]}],&quot;layoutName&quot;:&quot;accounts layout &quot;,&quot;skipDeptAccessValidation&quot;:false,&quot;createdBy&quot;:&quot;4000000015894&quot;,&quot;createdTime&quot;:&quot;2019-05-09T04:52:57.000Z&quot;,&quot;modifiedBy&quot;:&quot;4000000015894&quot;,&quot;id&quot;:&quot;4000000043004&quot;,&quot;status&quot;:&quot;active&quot;}