Edit Field
PATCH {{baseUrl}}/api/v1/organizationFields/:field_id
This API edits a field
OAuth Scope
Desk.settings.UPDATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| displayLabel | <string> max chars : 200 | Name of the field on the UI |
| name | <string> max chars : 200 | Name of the custom field |
| type | <string> max chars : 100 | Data type of the field. Values allowed are Text, Number, Percent, Decimal, Currency, Date, Date Time, Email, Phone, PickList, Website, Textarea, Checkbox, Multiselect, Boolean and LargeText |
| maxLength | <integer> | Maximum permissible length of the value in the field. Applicable for Text, Number, Decimal, and Currency fields |
| decimalPlaces | <integer> | Number of decimal places the value in a field can take. Applicable for Decimal and Currency fields |
| roundingPrecision | <integer> | Precision of the value in the field. Precision refers to the total number of digits in a decimal number. For example, the precision of 30.12 is 4. Applicable for Currency fields |
| roundingOption | <string> max chars : 120 | Option to round off complex decimal numbers to the nearest whole number or shorter decimal number. Values allowed are roundOff, roundDown, and roundUp |
| defaultValue | <string> max chars : 120 | Default value set for a field. Applicable for Checkbox fields |
| allowedValues | <list> | Values allowed in a field. Applicable for PickList fields |
| layoutIds | <list> | IDs of layouts configured for the module |
| isEncryptedField | <boolean> | Key that returns if the value in the field is encrypted or not. The field types are Text, Number, Percent, Decimal, Email, Phone, URL which supports encryption |
| toolTip | <string> max chars : 200 | the tool tip of the field |
| toolTipType | <string> max chars : 200 | the tool tip of the field |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"displayLabel":"Sample Text Field","apiName":"cf_sample_text_field","isCustomField":true,"toolTipType":"placeHolder","showToHelpCenter":false,"isEncryptedField":true,"toolTip":"Sample Text Field","id":"4000000049001","type":"Text","maxLength":40,"isMandatory":false}