Create a new article
Changed onCreate a new help center article in a collection. title, description and content may be sent either localized ({ "en": ... }) or as a bare value, which is stored under the help center's default language. project, helpcenterCollection, docId, lexorank, plainContent and baseAudienceFilter are assigned by the server and ignored if sent. The article is created unpublished (isDraft: true) unless isDraft: false is passed.
content is TipTap JSON. Images are image nodes referencing a hosted image URL: { "type": "image", "attrs": { "src": "<url>" } }. To host images on the Gleap CDN, upload them first via POST /v3/uploads (or import from an existing URL via POST /v3/uploads/from-url) and use the returned fileUrl as the src.
Request
- Base URLhttps://api.gleap.io/v3
- URLhttps://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles
- AuthHTTP bearer
Headers
Request body
Response
Ok
Changes
- info
the
request property default valuetruewas removed - info
the
request property default valueallwas removed
- info