Help center collections

Reorder collections

Changed on

Set the order of the collections on one level of the tree. Send every collection id in the order they should appear, plus the parentId whose children are being ordered (omit it for the top level). The server rewrites all of that level's ranks so the order is exact and stable; siblings left out keep their relative order and follow the listed ones. Returns the level's collections in their new order.

put/helpcenter/collections/order

Request

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

Request body

collectionIdsstring[] required

The ids of the collections on one level of the tree, in the order they should be shown. Siblings that are left out keep their relative order and are appended after the listed ones.

parentIdstring

The parent whose children are being ordered. Omit to order the top-level collections.

Response

Ok

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

Changes