Sign in

v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0187270483.0 KB
Entity Types

Update an Entity Type

patch/v3/entity-types/{typeID}

Path parameters

typeIDstring required

Entity type public ID (ety_...).

Request body

descriptionstring

New description.

parentTypeIDstring

New parent type public ID (ety_...), or an empty string to clear the parent (promote to top-level). Must belong to the same account+environment and may not be the type itself.

{"stackTrail":"components:schemas:EntityTypeUpdateRequestV3:properties:attributeSchema","oasType":"schema","type":"unknown","description":"New per-type structured attribute metadata."}

Response

The request has succeeded.

typeIDstring required

Stable public identifier for the entity type (ety_...).

namestring required

Human-facing type name. Unique within an account+environment, and immutable once set.

descriptionstring required

Optional human-facing note about the type.

parentTypeIDstring required

Public ID (ety_...) of the parent type, or an empty string when the type is top-level.

{"stackTrail":"components:schemas:EntityTypeV3:properties:attributeSchema","oasType":"schema","type":"unknown","description":"Optional per-type structured attribute metadata."}
createdAtstring date-time required

Creation timestamp (RFC 3339).

updatedAtstring date-time required

Last-update timestamp (RFC 3339).