Help center collections

Create a new collection

Changed on

Create a new help center collection. project, docId and lexorank are assigned by the server and ignored if sent. When parent is set, baseAudienceFilter is inherited from the parent collection (any value sent is overwritten) and an unknown parent returns 404.

post/helpcenter/collections

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/helpcenter/collections
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

titleunknown
descriptionunknown
iconUrlstring
projectstring
lexorankstring
docIdnumber double
parentstring
externalIdstring
targetAudiencestring

Who can read the collection. New collections default to all; an update that leaves it out keeps the current audience.

baseAudienceFilterunknown
extendedAudienceFilterunknown

Response

Ok

updatedAtstring required
createdAtstring required
iconUrlstring
extendedAudienceFilterunknown
baseAudienceFilterunknown
docIdnumber double
lexorankstring
externalIdstring
titleunknown
descriptionunknown
targetAudiencestring required

Changes