v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Taxonomy

updateTaxonomy

Update a taxonomy

put/v1/entity/taxonomies/{taxonomySlug}

Path parameters

taxonomySlugstring required

Taxonomy slug

Request body

slugstring

URL-friendly name for taxonomy

namestring

A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag

pluralstring

Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.

kind'system' | 'user_defined'

Kind of taxonomy e.g. system or user_defined. By default, it's empty, which means 'user_defined'

type'entity' | 'relation' | 'system' | 'file_collection'

Type of taxonomy. Whether it classifies:

entity (default)
relation (for relations)
system (for system taxonomies - default for all slugs starting with system)
file_collection (for file collections)

iconstring

Icon name for the taxonomy (from epilot360/icons icon set)

colorstring

HEX Color code for the taxonomy

created_atstring date-time

updated_atstring date-time

deleted_atstring date-time

Date when the taxonomy was soft-deleted (enabled: false)

created_bystring

User ID of the creator

enabledboolean

Whether the taxonomy is enabled or not

ordernumber

Position of the taxonomy

Example request

{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_by": "10598",
  "enabled": true,
  "order": 10
}

Response

Taxonomy updated