v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Configure Org Extended Field

This API lets you configure a extended field for the org and manage whether to show or hide it on your org’s InTouch.

post/entity/extended_field_config

Request body

extendedFieldIdinteger required

Unique ID of the extended field.

hideDisplayboolean required

Pass true to hide the field, false to show.

mandatoryboolean

Pass true to make the extended a mandatory option on the UI, false to make it an optional field.

updatableboolean

Specify true to allow updating extended field values once entered, false to disable updating extended field values. Applicable for Instore. No server side validation.

positioninteger

The position order of the extended field on the UI.

isPsiDataboolean

Indicates if the extended field is sensitive data

isPiiDataboolean

Indicates if the extended field is Personally Identifiable Information. Refer to the PSI data documentation for more information on classifying PSI data

Response

200

extendedFieldIdinteger

hideDisplayboolean

isPiiDataboolean

isPsiDataboolean

updatableboolean

mandatoryboolean

rejectTxnOnInvalidValueboolean

auditTrailEnabledboolean

Example response

{
  "extendedFieldId": 570,
  "isPsiData": true,
  "updatable": true
}