API Documentation

Configure Org Extended Field

post
https://{host}.api.capillarytech.com/v2/organization/entity/extended_field_config

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

Unique ID of the extended field.

boolean
required

Pass true to hide the field, false to show.

boolean

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

boolean

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

int32

The position order of the extended field on the UI.

boolean

Indicates if the extended field is sensitive data

boolean

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

Responses

Updated 2 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago