Skip to main content
PATCH
/
entities
/
{entityId}
/
fields
/
{fieldId}
Update entity field
curl --request PATCH \
  --url https://api.lithoblocks.com/entities/{entityId}/fields/{fieldId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "string",
  "description": "<string>",
  "isRequired": true,
  "arrayItemType": "string",
  "objectSchema": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "string",
  "description": "<string>",
  "isRequired": true,
  "parentFieldId": "<string>",
  "arrayItemType": "string",
  "objectSchema": {},
  "path": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

LithoBlocks API key obtained from your organization dashboard

Path Parameters

entityId
string
required
fieldId
string
required

Body

application/json

Field update data

name
string
type
enum<string>
Available options:
string,
number,
boolean,
date,
array,
object
description
string
isRequired
boolean
arrayItemType
enum<string>
Available options:
string,
number,
boolean,
date,
array,
object
objectSchema
object

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
isRequired
boolean
required
parentFieldId
string | null
required
arrayItemType
enum<string> | null
required
Available options:
string,
number,
boolean,
date,
array,
object
objectSchema
object
required
path
string[] | null
required
createdAt
string
required
updatedAt
string
required