> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Entity Type

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



## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml put /v2/entity-types/{id}
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Request API
  - name: Audit Log API
  - name: Change Blackout API
  - name: Change Model API
  - name: Custom Field API
  - name: Custom Service API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: Report API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/entity-types/{id}:
    put:
      tags:
        - Entity Type API
      summary: Update Entity Type
      description: >-
        Update an entity type's name, color, icon, or help-agent visibility.
        Omitted optional fields are left unchanged.
      operationId: svrelay.publicv2.PublicAPIServiceV2.UpdateEntityType
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            title: id
            description: The ID of the entity type to update.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  title: name
                  description: The display name of the entity type (required).
                color:
                  type: string
                  title: color
                  description: >-
                    Hex color for the entity type's icon. Omit to leave
                    unchanged.
                  nullable: true
                iconSlug:
                  type: string
                  title: icon_slug
                  description: >-
                    The Lucide icon slug for the entity type. Omit to leave
                    unchanged.
                  nullable: true
                helpAgentVisibility:
                  $ref: '#/components/schemas/svstore.HelpAgentEntityVisibility'
                  title: help_agent_visibility
                  description: >-
                    Controls whether the help agent can see entities of this
                    type. Omit to
                     leave unchanged.
                  nullable: true
              title: UpdateEntityTypeRequest
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svstore.publicapi.UpdateEntityTypeResponse
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
      security:
        - BearerAuth: []
components:
  schemas:
    svstore.HelpAgentEntityVisibility:
      type: string
      title: HelpAgentEntityVisibility
      enum:
        - HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED
        - HELP_AGENT_ENTITY_VISIBILITY_NONE
        - HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED
        - HELP_AGENT_ENTITY_VISIBILITY_ALWAYS
    svstore.publicapi.UpdateEntityTypeResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/svstore.EntityType'
          title: data
          description: The updated entity type.
          x-stainless-terraform-configurability: optional
      title: UpdateEntityTypeResponse
      additionalProperties: false
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          x-stainless-terraform-configurability: optional
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
          x-stainless-terraform-configurability: optional
        detail:
          $ref: '#/components/schemas/google.protobuf.Any'
          x-stainless-terraform-configurability: optional
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    svstore.EntityType:
      type: object
      properties:
        id:
          type: string
          title: id
          x-stainless-terraform-configurability: optional
        teamId:
          type: string
          title: team_id
          x-stainless-terraform-configurability: optional
        key:
          type: string
          title: key
          x-stainless-terraform-configurability: optional
        name:
          type: string
          title: name
          x-stainless-terraform-configurability: optional
        parentEntityTypeId:
          type: string
          title: parent_entity_type_id
          nullable: true
          x-stainless-terraform-configurability: optional
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          x-stainless-terraform-configurability: optional
        updatedAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: updated_at
          x-stainless-terraform-configurability: optional
        createdByUserId:
          type: string
          title: created_by_user_id
          x-stainless-terraform-configurability: optional
        updatedByUserId:
          type: string
          title: updated_by_user_id
          x-stainless-terraform-configurability: optional
        color:
          type: string
          title: color
          nullable: true
          x-stainless-terraform-configurability: optional
        iconSlug:
          type: string
          title: icon_slug
          x-stainless-terraform-configurability: optional
        entitySchemaId:
          type: string
          title: entity_schema_id
          x-stainless-terraform-configurability: optional
        helpAgentVisibility:
          $ref: '#/components/schemas/svstore.HelpAgentEntityVisibility'
          title: help_agent_visibility
          x-stainless-terraform-configurability: optional
        isEdgeType:
          type: boolean
          title: is_edge_type
          description: >-
            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.
          x-stainless-terraform-configurability: computed_optional
        description:
          type: string
          title: description
          description: >-
            What records of this type represent. Written by schema-template
            installs
             and surfaced to the help agent as retrieval context.
          nullable: true
          x-stainless-terraform-configurability: optional
      title: EntityType
      additionalProperties: false
      description: Normalized type (main version)
    google.protobuf.Any:
      type: object
      properties:
        type:
          type: string
          x-stainless-terraform-configurability: optional
        value:
          type: string
          format: binary
          x-stainless-terraform-configurability: optional
        debug:
          type: object
          additionalProperties: true
          x-stainless-terraform-configurability: optional
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
    google.protobuf.Timestamp:
      type: string
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````