Skip to main content
PATCH
/
v1
/
entities
/
{entity_id}
/
fields
/
{field_id}
Update entity field
curl --request PATCH \
  --url https://api.lithoblocks.com/v1/entities/{entity_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "is_required": true,
  "object_schema": null
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "is_required": true,
  "parent_field_id": "<string>",
  "path": [
    "<string>"
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "object_schema": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.lithoblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

LithoBlocks API key obtained from your organization dashboard

Path Parameters

​
entity_id
string
required
​
field_id
string
required

Body

application/json

Field update data

​
name
string
​
type
enum<string>
Available options:
string,
number,
boolean,
date,
array,
object
​
description
string
​
is_required
boolean
​
array_item_type
enum<string>
Available options:
string,
number,
boolean,
date,
array,
object
​
object_schema
unknown

Response

Updated field

​
id
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
string,
number,
boolean,
date,
array,
object
​
description
string | null
required
​
is_required
boolean
required
​
parent_field_id
string | null
required
​
array_item_type
enum<string> | null
required
Available options:
string,
number,
boolean,
date,
array,
object
​
path
string[] | null
required
​
created_at
string
required
​
updated_at
string
required
​
object_schema
unknown