Skip to main content
PATCH
/
v1
/
entities
/
{id}
curl --request PATCH \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/entities/{id}" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Updated Employee Entity",
    "viewPermission": ["HR", "MANAGER"]
  }'

​
Overview

Update an existing entity with new data. You can modify the entity name, view permissions, and parameter configurations.

​
Request Examples

The request body can include various fields depending on what you want to update. Here are common update scenarios: 
{
  "name": "Updated Employee Entity"
}

​
Example Request

curl --request PATCH \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/entities/{id}" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Updated Employee Entity",
    "viewPermission": ["HR", "MANAGER"]
  }'

​
Response

The endpoint returns a 204 No Content status code on successful update, indicating the entity has been updated successfully without returning the updated data in the response body.

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
​
description
string
​
viewPermission
string[]
​
parameters
object[]
​
dataProcessing
object[]
​
validations
object[]
​
registerUserRoles
boolean
​
legalContractId
string
​
sheetData
object

Response

204

ok