Sign in
Entity Type API

Create Entity Type

Create a new entity type with optional fields for a team.

post/v2/entity-types

Request body

teamIdstring

The ID of the team.

keystring nullable

The unique key for the entity type. If not provided, will be auto-generated from the name.

namestring

The display name of the entity type (required).

parentEntityTypeIdstring nullable

Optional parent entity type ID for nesting under a parent type.

schemaKeystring nullable

Optional schema key for placing the entity type in a non-default schema. When omitted, the entity type is created in the team's default schema. Use "reference-data" for entity types that represent external reference tables (e.g., ServiceNow reference tables) rather than user-facing assets.

helpAgentVisibility'HELP_AGENT_ENTITY_VISIBILITY_UNSPECIFIED' | 'HELP_AGENT_ENTITY_VISIBILITY_NONE' | 'HELP_AGENT_ENTITY_VISIBILITY_REQUESTER_ASSOCIATED' | 'HELP_AGENT_ENTITY_VISIBILITY_ALWAYS'
isEdgeTypeboolean nullable

When true, marks the type as an edge/relationship type whose instances connect two other entities. The type must have exactly two single-valued ENTITY_REF fields in fields (the endpoints); direction labels are derived from those field names, so no extra edge config is needed.

Response

Success

Changes