Skip to main content

Interface: UpdateCategoryInput

Defined in: type/UpdateCategoryInput.ts:7

Input object for UpdateCategoryInput

Properties

autoGenerateSlugs?

optional autoGenerateSlugs?: boolean

Defined in: type/UpdateCategoryInput.ts:44

Generates missing slugs from the localized names when set; existing slugs are preserved.

When enabled, slugs are regenerated from the localized names for any language whose slug is not explicitly supplied.


descriptions?

optional descriptions?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:28

Localized long-form descriptions shown on category landing surfaces.

Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input.


hidden?

optional hidden?: YesNo

Defined in: type/UpdateCategoryInput.ts:19

Category hidden status


metadataCanonicalUrls?

optional metadataCanonicalUrls?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:17

[SEO] Metadata canonical urls in different languages.


metadataDescriptions?

optional metadataDescriptions?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:13

[SEO] Metadata description in different languages.


metadataKeywords?

optional metadataKeywords?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:15

[SEO] Metadata keywords in different languages.


metadataTitles?

optional metadataTitles?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:11

[SEO] Metadata title in different languages.


names?

optional names?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:24

Localized names shown to end users in catalog and navigation surfaces. The catalogue's default language must be present.

Every entry must declare a distinct language. Cannot be combined with the single-language counterpart on the same input.


parent?

optional parent?: number

Defined in: type/UpdateCategoryInput.ts:9

The category's parent Category when available


parentUuid?

optional parentUuid?: string

Defined in: type/UpdateCategoryInput.ts:40

Globally unique identifier of the parent category. Omitted for root categories.

Cannot be combined with the legacy parent field on the same input.


shortDescriptions?

optional shortDescriptions?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:32

Localized short descriptions surfaced in listings and tiles.

Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input.


slugs?

optional slugs?: LocalizedStringInput[]

Defined in: type/UpdateCategoryInput.ts:36

URL-friendly identifiers, one per language, used in human-readable links.

Every entry must declare a distinct language. Each value must be a lowercase URL-friendly slug. Cannot be combined with the single-language counterpart on the same input.


sources?

optional sources?: SourceInput[]

Defined in: type/UpdateCategoryInput.ts:48

Pairs of external system names and the identifiers each system assigned to the record.

Replaces the existing list of external sources entirely.