Update an object's field definition

put

https://rls.congacloud.com/api/schema/v1/objects/{objectName}/fields/{fieldName}

Validates and updates the field definitions available in the specified object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

objectName

string

required

Name of the object in which the field is to be updated

fieldName

string

required

Name of the field to be updated

Body Params

Metadata update details for the field mentioned in the field name parameter.

DisplayName

string | null

Display name of the field

Description

string | null

Description of the field

DefaultValue

string | null

Default value of the field

IsSortable

boolean

Indicates if the field is sortable.

IsUnique

boolean

Indicates if the field is unique.

Expression

string | null

Expression of the field

Length

int32 | null

Length of the field when the data type is String or LongString.

TargetField

string | null

Target field of the field

RollupFunction

string | null

Rollup function of the field

RollupFilterCriteria

string | null

Rollup filter criteria of the field

IsRichTextField

boolean

Indicates if the field is RichText.

IsRequired

boolean

Indicates if the field is required.

Precision

int32 | null

The number of digits when the data type is Decimal, Double, or Currency

Scale

int32 | null

The number of digits to the right of the decimal point when the data type is Decimal, Double, or Currency

LookupFilterCriteria

string | null

Lookup filter criteria for UI

AutoNumberPrefix

string | null

Prefix for AutoNumber fields

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request

404

Not Found

500

Internal Server Error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success