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/helpcenter/collections/{helpcenterCollectionId}/toggle-publish

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/toggle-publish
  • Auth
    HTTP bearer

Path parameters

helpcenterCollectionIdstring required

Headers

projectstring required

Request body

unpublishedboolean required

Response

Ok

successboolean required

Changes

No recorded changes to this operation across all 56 revisions of this API.