help-desk

Create an article draft

Changed on

Uses the organization administrator's own console session, never an API key or impersonated session. The help desk must be active. Management writes require an active admin with a Full License and a matching version; private content stays encrypted in the desk vault until explicitly published.

post/products/help-desk/knowledge-base/articles

Request

Request body

titlestring required
slugstring required
summarystring
body_markdownstring required

Nonempty Markdown, at most 500 KiB in UTF-8. Stored as an immutable encrypted revision.

category_idstring nullable
positioninteger
seo_titlestring nullable
seo_descriptionstring nullable
seo_keywordsstring[]
related_article_idsstring[]
pathstring nullable

Optional safe root-relative published path; authentication, portal and internal paths are reserved.

featuredboolean
popular_rankinteger nullable
cover_image_urlstring nullable

Response

The saved result.

Changes

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status