Skip to main content
PATCH
/
v1
/
entity_types
/
{entityTypeId}
Update an Entity Type
curl --request PATCH \
  --url https://api.us.lexful.app/v1/entity_types/{entityTypeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ID: <api-key>' \
  --data '
{
  "display_name": "Secure Projects - Enhanced",
  "description": "Project management with enhanced security features and compliance tracking",
  "properties": [
    {
      "name": "project_name",
      "type": "string",
      "display_name": "Project Name",
      "description": "Name of the project",
      "required": true
    },
    {
      "name": "budget",
      "type": "number",
      "display_name": "Budget",
      "description": "Project budget in dollars",
      "required": false
    },
    {
      "name": "compliance_level",
      "type": "string",
      "display_name": "Compliance Level",
      "description": "Required compliance level",
      "required": false,
      "enum": [
        "Standard",
        "High",
        "Critical"
      ]
    }
  ]
}
'
{
  "id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
  "account_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
  "name": "system.contact",
  "display_name": "Contacts",
  "description": "Contacts are people and identities associated with an organization",
  "is_system": true,
  "properties": [
    {
      "name": "first_name",
      "type": "string",
      "display_name": "First Name",
      "required": false
    },
    {
      "name": "last_name",
      "type": "string",
      "display_name": "Last Name",
      "required": false
    },
    {
      "name": "title",
      "type": "string",
      "display_name": "Title",
      "required": false
    },
    {
      "name": "important",
      "type": "boolean",
      "display_name": "Important",
      "required": true
    },
    {
      "name": "contact_type",
      "type": "string",
      "display_name": "Contact Type",
      "required": false,
      "enum": [
        "Approver",
        "Champion",
        "Decision Maker",
        "End User",
        "Evaluator",
        "Influencer",
        "Owner",
        "Other"
      ]
    },
    {
      "name": "contact_methods",
      "type": "array",
      "display_name": "Contact Methods",
      "required": false,
      "array": {
        "type": "object",
        "properties": [
          {
            "name": "type",
            "type": "string",
            "display_name": "Contact Method Type",
            "required": true,
            "enum": [
              "Phone",
              "Fax",
              "Mobile",
              "Email",
              "Website",
              "Twitter",
              "LinkedIn",
              "Other"
            ]
          },
          {
            "name": "value",
            "type": "string",
            "display_name": "Contact Method Value",
            "required": true
          }
        ]
      }
    },
    {
      "name": "preferred_contact_method",
      "type": "string",
      "display_name": "Preferred Contact Method",
      "required": false,
      "enum": [
        "Phone",
        "Fax",
        "Mobile",
        "Email",
        "Website",
        "Twitter",
        "LinkedIn",
        "Other"
      ]
    },
    {
      "name": "notes",
      "type": "richtext",
      "display_name": "Notes",
      "required": false
    }
  ],
  "references": [
    {
      "name": "location",
      "display_name": "Location",
      "required": false,
      "multiple": false,
      "target_entity_types": [
        "system.location"
      ]
    }
  ],
  "version": 1,
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:30:00.000Z",
  "created_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
  "updated_by": "019983a9-c4c0-73af-aec9-463feeadc2e7"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

entityTypeId
string<uuid>
required

Entity type ID

Body

application/json
display_name
string

Display name

Required string length: 1 - 255
description
string

Entity type description

Maximum string length: 1000
properties
object[]

Entity type properties

references
object[]

Entity type references

ui_config
object

UI configuration

Response

Default Response

id
string<uuid>
required

Entity type unique identifier

name
string
required

Entity type name (unique, used in URLs)

display_name
string
required

Display name for UI

is_system
boolean
required

Whether this is a system entity type

properties
object[]
required

Entity type properties

version
number
required

Entity type version

account_id
string<uuid>

Account ID

description
string

Entity type description

references
object[]

Entity type references

ui_config
object

UI configuration

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

created_by
string

User ID who created

updated_by
string

User ID who last updated