This article describes how to create Manuals, Chapter and Articles via the API.
All updates you make via the API will appear in Activity logs as if they were done by the user whose credentials are used when making the API calls.
Explanation
Key |
Value |
---|---|
position |
Position of the article in the chapter. |
title |
Article title. Up to 255 characters. |
published |
Boolean |
manual_id |
ID of the chapter the article is assigned to. |
meta_search |
Additional search terms for the article. Up to 255 characters. |
meta_description |
The description that is shown to search engines. Up to 255 characters. |
meta_title |
Page title shown to search engines. Up to 255 characters. |
exclude_from_search |
Boolean. Determines whether an article will be excluded from the ScreenSteps public search. |
tags |
An array of tag names. |
There is a separate API endpoint for updating article contents. See: Updating article content through the API
0 Comments
Add your comment