v4

OpenAPI 3.0.02026-07-31257282489.4 KB

Help center collections

Update a collection

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}

Path parameters

helpcenterCollectionIdstring required

Request body

{"stackTrail":"components:schemas:HelpCenterCollectionDto:properties:title","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpCenterCollectionDto:properties:description","oasType":"schema","type":"unknown"}

iconUrlstring

projectstring

lexorankstring

docIdnumber double

parentstring

externalIdstring

targetAudiencestring

{"stackTrail":"components:schemas:HelpCenterCollectionDto:properties:baseAudienceFilter","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpCenterCollectionDto:properties:extendedAudienceFilter","oasType":"schema","type":"unknown"}

Response

updatedAtstring required

createdAtstring required

iconUrlstring

{"stackTrail":"components:schemas:HelpcenterCollectionDocument:allOf:properties:extendedAudienceFilter","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterCollectionDocument:allOf:properties:baseAudienceFilter","oasType":"schema","type":"unknown"}

docIdnumber double

lexorankstring

externalIdstring

{"stackTrail":"components:schemas:HelpcenterCollectionDocument:allOf:properties:title","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:HelpcenterCollectionDocument:allOf:properties:description","oasType":"schema","type":"unknown"}

targetAudiencestring required