Skip to content

Update a category (only the fields sent)

PATCH
/categories/{id}
curl --request PATCH \
--url https://api.motenya.app/v1/categories/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "parentId": "example", "slug": "getting-started", "name": "example", "description": "example", "icon": "example", "tags": [ "example" ], "position": 1 }'

Requires categories:write. Send null to clear an optional field.

id
required
string
>= 1 characters <= 64 characters
Media typeapplication/json
object
parentId

Parent category (same KB and language); null for top level.

string | null
>= 1 characters <= 64 characters
slug

Lowercase letters, digits and single hyphens; unique per knowledge base and language.

string
<= 120 characters /^[a-z0-9]+(?:-[a-z0-9]+)*$/

Example

getting-started
name
string
>= 1 characters <= 120 characters
description
string | null
<= 1000 characters
icon
string | null
<= 100 characters
tags
Array<string>
<= 30 items
position
integer
<= 100000

Updated

Media typeapplication/json
object
id
required
string
>= 1 characters <= 64 characters
kbId
required
string
>= 1 characters <= 64 characters
language
required
string
parentId
required
string | null
>= 1 characters <= 64 characters
slug
required
string
name
required
string
description
required
string | null
icon
required
string | null
tags
required
Array<string>
hidden
required
boolean
translationGroupId
required
string | null
translations
required
Array<object>
object
language
required
string
slug
required
string
children
required

Child categories, recursively.

Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kbId
required
string
>= 1 characters <= 64 characters
language
required
string
parentId
required
string | null
>= 1 characters <= 64 characters
slug
required
string
name
required
string
description
required
string | null
icon
required
string | null
tags
required
Array<string>
hidden
required
boolean
translationGroupId
required
string | null
translations
required
Array<object>
object
language
required
string
slug
required
string
key
additional properties

Example generated

{
"id": "example",
"kbId": "example",
"language": "example",
"parentId": "example",
"slug": "example",
"name": "example",
"description": "example",
"icon": "example",
"tags": [
"example"
],
"hidden": true,
"translationGroupId": "example",
"translations": [
{
"language": "example",
"slug": "example"
}
],
"children": [
{
"id": "example",
"kbId": "example",
"language": "example",
"parentId": "example",
"slug": "example",
"name": "example",
"description": "example",
"icon": "example",
"tags": [
"example"
],
"hidden": true,
"translationGroupId": "example",
"translations": [
{
"language": "example",
"slug": "example"
}
]
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error