Skip to main content
POST
Error

Autorizações

Authorization
string
header
obrigatório

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.

Cabeçalhos

X-Organization-Id
string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.

Corpo

application/json
slug
string
obrigatório
Exemplo:

"getting-started"

name
string
obrigatório
description
string
position
integer

Display order on the public index; ties fall back to the name.

icon
string

The glyph the public index draws beside the heading, named as lucide names them (PascalCase). Empty means none, and a name the help center's catalogue does not hold draws the default glyph rather than failing.

Exemplo:

"CreditCard"

Resposta

The collection.

A heading of the help center. Organization-scoped — the same collection serves both environments' keys.

id
string<uuid>
slug
string

The public URL segment, unique per organization case-insensitively.

name
string
description
string
position
integer

Display order on the public index.

icon
string

The glyph drawn beside the heading, named as lucide names them (CreditCard, ShieldCheck). Empty means none. The catalogue lives in the pages that render the help center, so an unrecognised name draws the default glyph instead of an error — which is what lets the catalogue grow without a release here.

created_at
string<date-time>
updated_at
string<date-time>