Skip to main content
PUT
Update Entity Type

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the entity type to update.

Body

application/json
name
string

The display name of the entity type (required).

color
string | null

Hex color for the entity type's icon. Omit to leave unchanged.

iconSlug
string | null

The Lucide icon slug for the entity type. Omit to leave unchanged.

helpAgentVisibility
enum<string> | null

Controls whether the help agent can see entities of this type. Omit to leave unchanged.

Available options:
HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED,
HELP_AGENT_ENTITY_VISIBILITY_NONE,
HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED,
HELP_AGENT_ENTITY_VISIBILITY_ALWAYS

Response

Success

data
data · object

The updated entity type.