How to Create a Folder via API
The ProProfs Knowledge Base API allows you to create and manage folders within your knowledge base programmatically. This API helps you organize your content more effectively by structuring it into relevant categories.
Key Features
- Create Folders: Easily create new folders to categorize your knowledge base content.
- Organize Content: Manage your folders to keep your knowledge base well-structured and user-friendly.
- Integration: Integrate seamlessly with other systems to automate content management.
Getting Started
To use the ProProfs Knowledge Base API, obtain an API key and include it in your request headers.
Endpoint URL
http://www.helpdocsonline.com/proprofsapi/folder/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” |
|
|
folder_name |
Yes |
String |
The name of the folder will be displayed in table of contents |
|
|
folder_content |
No |
String |
Folder content in case the folder page is ON |
|
|
folder_title |
No |
String |
Title of the Folder. It will display in the page title if folder page is ON |
Blank |
|
folder_hidden |
No |
Numeric |
0 = Not hidden, 1 = Hidden from visitors |
0 |
|
folder_open |
No |
Numeric |
Default open folder for visitors 1= Default open, 0 = Default not open |
By default, it will create a root label at the last position |
| topic_id | No | Numeric | ID of the parent topic/article | By default, it will create a root label at the last position |
|
folder_id |
No |
Numeric |
ID of the parent folder |
0 |
Example Request
POST https://www.helpdocsonline.com/proprofsapi/article/v1
Accept: application/json
{
"action":"create",
"api_key":"df84a943b2388f41563afed1ba343ghyt0488ac",
"folder_name":"how to create a folder",
"folder_content":"<p>This is sample data</p>",
"folder_id":207178
}
Response Format
JSON
Response Fields
|
Name |
Description |
|
folder_id |
ID of the folder |
|
status |
Success/Failed with error |
| msg |
|
Response Example
Content-Type: application/json
{
"status":"SUCCESS",
"msg":"Folder created successfully",
"folder_id":2257336
}