Skip to main content
POST
Create a help center topic

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

helpCenterId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
name
string
required
Minimum string length: 1
slug
string
description
string

Short blurb shown under the topic name on the help-center home grid.

icon
string

Lucide icon name in kebab-case (e.g. 'folder', 'credit-card', 'shopping-cart' — see lucide.dev/icons). Unknown names render no icon.

parent_id
string<uuid> | null

Create as a subtopic of this topic; omit or null for a top-level topic.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

entity
object
required
primaryLocale
object
required