Skip to main content
PUT
Update a Help Center collection

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header: Bearer pk_.... Older pk_live_ and pk_test_ keys remain valid; their prefixes do not isolate data or select a separate environment.

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[!-~]{8,128}$

Path Parameters

id
string
required

Body

application/json
name
string
required
slug
string
required
locale
string
required
expectedRevision
integer
required
Required range: x >= 1
parentId
string | null
description
string
position
integer
Required range: x >= 0

Response

Authorized result; identical write retries replay the original result.

id
string
parentId
string | null
slug
string
name
string
description
string
position
integer
articleCount
integer
revision
integer
createdAt
string<date-time>
updatedAt
string<date-time>
translations
object[]