Help center collections

Update a collection

Changed on

Update a help center collection. Changing targetAudience, baseAudienceFilter or extendedAudienceFilter also re-applies the resulting audience filter to every article in this collection and, recursively, to all subcollections and their articles.

put/helpcenter/collections/{helpcenterCollectionId}

Request

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

Path parameters

helpcenterCollectionIdstring 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