Skip to main content
PUT
/
api
/
v1
/
schema
/
{schemaId}
/
fields
/
{metaFieldId}
Update field.
curl --request PUT \
  --url https://api.revong.com/api/v1/schema/{schemaId}/fields/{metaFieldId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "category": "<string>",
  "desc": "<string>",
  "fieldType": "Text",
  "lazy": true,
  "lazyId": "<string>",
  "lazyType": "<string>",
  "prefix": "<string>",
  "suffix": "<string>",
  "rowGroup": true,
  "editable": true,
  "required": true,
  "hide": true,
  "filter": true,
  "sortable": true,
  "order": 123,
  "restricted": true,
  "active": true,
  "groups": [
    "<string>"
  ],
  "users": [
    "<string>"
  ],
  "pinned": "<string>",
  "pivot": true,
  "fontColor": "<string>",
  "backgroundColor": "<string>",
  "options": [
    {
      "name": "<string>",
      "value": "<string>",
      "order": 123
    }
  ],
  "version": 123
}'

Authorizations

​
Authorization
string
header
required

Bearer token with Platform JWT token or API Key.

Path Parameters

​
schemaId
string
required
​
metaFieldId
string
required

Body

application/json
​
version
number
required

You must provide current version.

​
name
string

Name.

​
category
string

Category.

​
desc
string

Description.

​
fieldType
enum<string>

You need to specify field type [Text,Integer,Numeric,Quantity,DateTime,Boolean,Single,Multi,URL,Phone,Mail,Groups,Users,Created Time,Created By,Last Update Time,Last Update By,Resources,Key,ResourcesItems,Percent,Money,Version].

Available options:
Text,
Integer,
Numeric,
Quantity,
DateTime,
Boolean,
Single,
Multi,
URL,
Phone,
Mail,
Groups,
Users,
Created Time,
Created By,
Last Update Time,
Last Update By,
Resources,
Key,
ResourcesItems,
Percent,
Money,
Version
​
lazy
boolean

Specify if lazy loading is enabled (e.g. list, dropdown options and more).

​
lazyId
string

lazyId.

​
lazyType
string

Description.

​
prefix
string

Prefix of value, for example of Money you can specify currency e.g. $ 123,40

​
suffix
string

Suffix of value, for example of Money you can specify currency e.g. 123,40 PLN

​
rowGroup
boolean

Select if row group is enabled.

​
editable
boolean

Select if should be editable (e.g. row change).

​
required
boolean

You need to specific if field will be required to fill.

​
hide
boolean

Select if should be hidden by default.

​
filter
boolean

Select if should be filtered.

​
sortable
boolean

Select if should be sortable.

​
order
number

You can specify order of an field.

​
restricted
boolean

Provide if access should be restricted.

​
active
boolean

Provide if should be active/visible to users.

​
groups
string[]

Provide which groups should have access to it, once restricted is true.

​
users
string[]

Provide which users should have access to it, once restricted is true.

​
pinned
string

Mark if should be pinned (left or right).

​
pivot
boolean

Specify if Pivot is enabled by default.

​
fontColor
string

Global font color of the field value.

​
backgroundColor
string

Global background color of the field.

​
options
object[]

Provide value options (1-300).

Response

OK.