---
title: "Update Entity Type"
method: PUT
path: "/v2/entity-types/{id}"
tags: ["Entity Type API"]
---

# Update Entity Type

`PUT /v2/entity-types/{id}`

Update an entity type's name, color, icon, or help-agent visibility. Omitted optional fields are left unchanged.

## Path parameters

- `id` string, required — The ID of the entity type to update.

## Request body

- object
  - `name` string — The display name of the entity type (required).
  - `color` string, nullable — Hex color for the entity type's icon. Omit to leave unchanged.
  - `iconSlug` string, nullable — The Lucide icon slug for the entity type. Omit to leave unchanged.
  - `helpAgentVisibility` 'HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED' | 'HELP_AGENT_ENTITY_VISIBILITY_NONE' | 'HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED' | 'HELP_AGENT_ENTITY_VISIBILITY_ALWAYS'

## Response `200`

Success

- SvstorePublicapiUpdateEntityTypeResponse
  - `data` SvstoreEntityType — Normalized type (main version)
    - `id` string
    - `teamId` string
    - `key` string
    - `name` string
    - `parentEntityTypeId` string, nullable
    - `createdAt` string, date-time — A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    - `updatedAt` string, date-time — A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    - `createdByUserId` string
    - `updatedByUserId` string
    - `color` string, nullable
    - `iconSlug` string
    - `entitySchemaId` string
    - `helpAgentVisibility` 'HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED' | 'HELP_AGENT_ENTITY_VISIBILITY_NONE' | 'HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED' | 'HELP_AGENT_ENTITY_VISIBILITY_ALWAYS'
    - `isEdgeType` boolean — When true, this type's instances represent a relationship/edge between two other entities. An edge type has exactly two single-valued ENTITY_REF fields (its endpoints); the asset graph collapses such an entity into a directed edge instead of a node, labeling each direction with the name of the ENTITY_REF field pointing at the neighbor. No extra config is stored: direction is implicit in which endpoint field you read.
    - `description` string, nullable — What records of this type represent. Written by schema-template installs and surfaced to the help agent as retrieval context.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/serval/apis/serval-public-api.md) · [All operations](https://skmtc.net/serval/apis/serval-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/serval/serval-public-api/versions/0549515e9384/schema)
