v4

OpenAPI 3.0.02026-07-31257282489.4 KB

Help center collections

Create a new collection

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

Headers

projectstring 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