Update Custom Field - HYEGRO Docs

Request

Path Params

field_id

integer

Field Id

required

Query Params

schema

Schema

optional

Any of

string

null

Body Params application/json

table_name

string

Table Name

required

ui_label

string

Ui Label

required

type

Type

optional

Field type: int, string, char, or boolean

Any of

string

null

Match pattern:

^(int|string|char|boolean)$

is_required

boolean

Is Required

required

Example

{
  "table_name": "string",
  "ui_label": "string",
  "type": "string",
  "is_required": true
}

Responses

🟢200OK

application/json

Successful Response

Body

integer

required

table_name

string

Table Name

required

ui_label

string

Ui Label

required

type

Type

required

Any of

string

null

is_required

boolean

Is Required

required

cf_name

integer

Cf Name

required

column_name

string

Column Name

required

Example

{
  "id": 0,
  "table_name": "string",
  "ui_label": "string",
  "type": "string",
  "is_required": true,
  "cf_name": 0,
  "column_name": "string"
}

🟠422Parameter Error