Object fields
Update object field
Updates a field's metadata, defaults, or ordering. Requires a USER API key with ADMIN or OWNER role.
patch/public/v1/objects/{name}/fields/{fieldId}
Path parameters
namestring required
Example:deals
fieldIdinteger required
Example:42
Request body
Example request
{
"name": "example",
"type": "string",
"order": 1
}Response
Updated field
Example response
{
"ok": true,
"data": {
"id": 1,
"name": "example",
"key": "example",
"type": "example",
"created_at": "example",
"updated_at": "example",
"format": "example",
"mode": "singleSelect",
"timezone": "example",
"decimals": 1,
"currency": "example",
"min": 1,
"max": 1,
"time_format": "example",
"allowed_file_types": [
"example"
],
"max_file_size": 1,
"related_table_id": 1,
"related_record_type_ids": [
1
],
"display_field_id": 1,
"relation_mode": "example",
"options": [
{
"id": 1,
"name": "example",
"color": "example",
"order": 1,
"created_at": "example",
"updated_at": "example"
}
],
"output_type": "example"
}
}