Qodex.ai

Update Layout Field

PATCH {{baseUrl}}/api/v1/layouts/:layout_id/fields/{field_id}

This API updates details of a field in the layout.

OAuth Scope

  • Desk.settings.UPDATE

Request Params

KeyDatatypeRequiredDescription
expressionstringFormula Expression
isMandatorystringKey that returns if a field is mandatory in a layout or not
defaultValuestringDefault value set for a field. Applicable for Checkbox fields and PickList fields
allowedValuesstringValues allowed in a field. Applicable for PickList fields
sortBystringKey that sorts values in a PickList field either alphabetically or by a user-defined order

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"displayLabel":"Multiselect 1","allowedValues":["option 3","option 4","option 1","option 2"],"apiName":"cf_multiselect_1","isCustomField":true,"defaultValue":"option 3","i18NLabel":"Multiselect 1","isSystemMandatory":false,"type":"Multiselect","name":"Multiselect 1","sortBy":"userDefined","id":"21000000023005","isRemovable":true,"maxLength":120,"isMandatory":true}