Help center collections

Publish or unpublish a collection's articles

Publish or unpublish every article in a help center collection. Set unpublished to true to unpublish or false to publish; the change is applied recursively to all articles in this collection and in all of its subcollections. The collection document itself is not modified. Returns { success: true }.

PUT

https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/toggle-publish

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

helpcenterCollectionIdstringrequired

Headers

projectstringrequired

Bodyapplication/jsonrequired

unpublishedbooleanrequired

Response

application/json

successbooleanrequired

Updated November 1, 2026

curl --request PUT \
  --url 'https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/toggle-publish' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{
  "unpublished": true
}'

{
  "success": true
}