How to Create a Page via API
The ProProfs Knowledge Base API allows you to create and manage content in your knowledge base programmatically. Using this API, you can automate the creation of knowledge base pages, making it easier to maintain and update your documentation.
Key Features:
- Create Pages: Automate the creation of new pages in your knowledge base.
- Manage Content: Easily update or delete existing pages.
- Integration: Seamlessly integrate with other tools and platforms to streamline your content management process.
Getting Started
You will need an API key to use the ProProfs Knowledge Base API. To authenticate your requests, include the API key in your headers.
Endpoint URL
https://www.helpdocsonline.com/proprofsapi/article/v1
Request Method
POST
Request Format
JSON
Post Parameters
|
Name |
Required |
Type |
Description |
Default |
|
api_key |
Yes |
String |
Your private API key for the FAQ. The API key is available at: Settings > In-App Help > API key |
|
|
action |
Yes |
string |
Action of the API. “create” |
|
|
topic_title |
Yes |
String |
Article title |
|
|
topic_content |
yes |
String |
Article content (body) |
|
|
topic_type |
No |
Numeric |
Type of the page 0 = Article, 1 = Video |
0 |
|
toc_name |
No |
String |
Article TOC name |
topic_title |
|
folder_id |
No |
Numeric |
Folder ID |
By default it will create at root label at last position |
| topic_id | No | Numeric | Article ID | By default it will create at root label at last position |
|
topic_toc |
No |
Numeric |
Hidden from TOC 0 = No, 1 = Yes |
0 |
| topic_status | No | Numeric |
1 = Available as published article 0 = Available as draft article |
0 |
|
topic_keywords |
No |
String |
Search keywords |
blank |
Example Request
POST https://www.helpdocsonline.com/proprofsapi/article/v1
Accept: application/json
{
"action":"create",
"api_key":"df84a943b2388f41563afed1ba343ghyt0488ac",
"topic_title":"how to create a page",
"topic_content":"<p>This is sample data</p>",
"topic_type":0,
"topic_toc":1,
"toc_name":"Create a page",
"folder_id":207178,
"keywords":"Few keywords"
}
Response Format
JSON
Response Fields
|
Name |
Required |
|
topic_id |
Article ID |
|
url |
URL of the article |
| msg | Message of the Article |
Response Example
Content-Type: application/json
{
"status":"SUCCESS",
"msg":"Article created successfully",
"topic_id":2257336,
"url":"http:\/\/sample.helpdocsonline.com\/ID2257336"
}